Inventory API version v14.0
http://localhost
Inventory API
API for interacting with an inventory of physical resources
/inventory
Collection of item items.
get
Retrieve a list of item items.
post
Create a new item item.
delete
get /inventory/items
Retrieve a list of item items.
Query Parameters
- offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)
Skip over a number of elements by specifying an offset value for the query
Example:
0 - limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)
Limit the number of elements returned in the response
Example:
10 - query: (string)
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
using CQL (indexes for item and material type)
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode barcode=="65345656554" - lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 200
Returns a list of item items
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A collection of item records",
"type": "object",
"properties": {
"items": {
"description": "List of item records",
"id": "items",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An item record",
"properties": {
"id": {
"description": "Item id",
"type": "string"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"description": "ID of the holdings record the item is a member of",
"type": "string"
},
"order": {
"type": "integer",
"description": "Order of the item in the holdings record."
},
"formerIds": {
"type": "array",
"description": "Previous identifiers assigned to the item",
"items": {
"type": "string"
},
"uniqueItems": true
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"displaySummary": {
"description": "Display summary about the item",
"type": "string"
},
"title": {
"type": "string",
"description": "Resouce title (read only, inherited from associated instance record)",
"readonly": true
},
"contributorNames": {
"description": "A list of contributor names",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The contributor name",
"type": "string"
}
}
}
},
"additionalCallNumbers": {
"description": "Additional Call Numbers to track the history of identifiers assigned to an item.",
"type": "array",
"items": {
"type": "object",
"uniqueItems": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An additional call number",
"properties": {
"typeId": {
"type": "string",
"description": "unique ID for the type of call number, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"prefix": {
"type": "string",
"description": "Prefix of the call number."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item or holding, usually printed on a label attached to the item."
},
"suffix": {
"type": "string",
"description": "Suffix of the call number."
}
},
"required": [
"callNumber"
]
}
},
"callNumber": {
"type": "string",
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record)",
"readonly": true
},
"barcode": {
"description": "Text, with input likely validated by the barcode scanner",
"type": "string"
},
"effectiveShelvingOrder": {
"type": "string",
"description": "A system generated normalization of the call number that allows for call number sorting in reports and search results",
"readonly": true
},
"accessionNumber": {
"type": "string",
"description": "Accession number is also called inventar number. Accession number is a unique number assigned to an item in the order in which it is added to a library collection. Most libraries assign accession numbers in continous numerical sequece, but some use a code system to indicate type of material and/or year of accession in addition to order of accession"
},
"itemLevelCallNumber": {
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record). The item level call number, is the call number on item level",
"type": "string"
},
"itemLevelCallNumberPrefix": {
"description": "Prefix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberSuffix": {
"description": "Suffix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberTypeId": {
"description": "Call number type, refers to a call-number-type reference record",
"type": "string"
},
"effectiveCallNumberComponents": {
"type": "object",
"description": "Elements of a full call number generated from the item or holding",
"properties": {
"callNumber": {
"type": "string",
"description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"prefix": {
"type": "string",
"description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"suffix": {
"type": "string",
"description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"typeId": {
"type": "string",
"description": "Effective Call Number Type Id is the call number type id assigned to the item or associated holding.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"volume": {
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of Gerorge Bernard Shaw in three volumes)",
"type": "string"
},
"enumeration": {
"description": "Enumeration is the descriptive information for the numbering scheme of a serial, usually identified by level and a descriptive caption, e.g., level 0 = v. and level 1 = no. This means that each issue of the serial has a volume and an issue number that would appear (e.g. v.71:no.6-2)",
"type": "string"
},
"chronology": {
"description": "Chronology is the descriptive information for the dating scheme of a serial, usually identified by level, e.g., level 0 = year level 1 = month. This means that each issue of the serial has a month and a year on each issue (e.g. 1985:July-Dec.)",
"type": "string"
},
"yearCaption": {
"description": "In multipart monographs, a caption is characters used to label a level of chronology (e.g. 'year 1985')",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"description": "Item identifier number, e.g. imported from the union catalogue (read only)",
"type": "string"
},
"copyNumber": {
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; a copy of a multi-volume, (e.g. Copy 1, or C.7.)",
"type": "string"
},
"numberOfPieces": {
"description": "Number of pieces. Used when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set)",
"type": "string"
},
"descriptionOfPieces": {
"description": "Text which descripe the pieces",
"type": "string"
},
"numberOfMissingPieces": {
"description": "Number of missing pieces",
"type": "string"
},
"missingPieces": {
"description": "Text which descripes the missing pieces",
"type": "string"
},
"missingPiecesDate": {
"description": "Date when the piece(s) went missing",
"type": "string"
},
"itemDamagedStatusId": {
"description": "Item Damage status Id, refers to an Item damage Status ID reference record",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date when damage status was last changed",
"type": "string"
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"description": "notes",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Note for item record",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.ItemNotes",
"additionalProperties": false,
"properties": {
"itemNoteTypeId": {
"description": "Item note type, refers to a item-note-type reference record",
"type": "string"
},
"note": {
"description": "Text to display (e.g. action note, binding, use and reproduction)",
"type": "string"
},
"staffOnly": {
"description": "Records the fact that the record should only be displayed for staff",
"type": "boolean",
"default": false
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"noteType": {
"type": "string",
"description": "Type of circulation process that the note applies to",
"enum": [
"Check in",
"Check out"
]
},
"note": {
"type": "string",
"description": "Text to display"
},
"staffOnly": {
"type": "boolean",
"description": "Records the fact that the note should only be displayed for staff",
"default": false
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting.",
"readonly": true,
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note",
"readonly": true
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"readonly": true,
"properties": {
"lastName": {
"type": "string",
"description": "The user's last name",
"readonly": true
},
"firstName": {
"type": "string",
"description": "The user's first name",
"readonly": true
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting.",
"readonly": true
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the item state (e.g. Available, Checked out, In transit, Awaiting pickup, On order). Default value is set to: Available",
"type": "string",
"enum": [
"Aged to lost",
"Available",
"Awaiting delivery",
"Awaiting pickup",
"Checked out",
"Claimed returned",
"Declared lost",
"Lost and paid",
"Long missing",
"Missing",
"In process",
"In process (non-requestable)",
"In transit",
"Intellectual item",
"On order",
"Order closed",
"Paged",
"Restricted",
"Unavailable",
"Unknown",
"Withdrawn"
]
},
"date": {
"description": "Date of the current item state. E.g. date set when item state was changed by the Check out app",
"type": "string",
"readonly": true,
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"materialType": {
"description": "Material type define what type of thing the item is",
"type": "object",
"properties": {
"id": {
"description": "Material type Id, refers to a material type reference record",
"type": "string"
},
"name": {
"description": "Material type name (e.g. Audio book, Audio disc, Computer file, Pamphelet) ",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"isBoundWith": {
"description": "Indicates if this Item is a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"boundWithTitles": {
"description": "List of titles that are bound together within this Item",
"type": "array",
"items": {
"type": "object",
"description": "A title that is bound with other titles within this Item",
"properties": {
"briefHoldingsRecord": {
"type": "object",
"description": "Information about a holdings record that links a title to the bound-with Item",
"properties": {
"id": {
"description": "The UUID of the holdingsRecord",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the holdingsRecord",
"type": "string"
}
},
"additionalProperties": false
},
"briefInstance": {
"type": "object",
"description": "Information about an Instance / title that is bound with other title within this Item",
"properties": {
"id": {
"description": "The UUID of the Instance",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the Instance",
"type": "string"
},
"title": {
"description": "The title of the Instance",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"readonly": true
},
"permanentLoanType": {
"description": "Permanent loan type, is the default loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Permanent loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Permanent loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLoanType": {
"description": "Temporary loan type, is the temporary loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Temporary loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Temporary loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"permanentLocation": {
"description": "Permanent item location is the default location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Permanent location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Permanent location type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLocation": {
"description": "Temporary item location is the temporarily location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Temporary location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Temporary location name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"effectiveLocation": {
"type": "object",
"description": "The effective location is used by FOLIO and other integrated systems to know the current home location for the item (read only, derived from locations on HoldingsRecord and Item)",
"readonly": true,
"properties": {
"id": {
"type": "string",
"readonly": true
},
"name": {
"description": "Effective location name",
"type": "string",
"readonly": true
}
}
},
"electronicAccess": {
"description": "Whether an item is available electronically",
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "Link text is used for display in place of the URL"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id, refers to a Relationship type reference record. Relationship between the electronic resource at the location identified and the item described in the record as a whole. (E.g. values from MARC 21, tag field 856 2nd indicator, where the values are: No information provided, Resource, Version of resource, Related resource, No display constant generate"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "Statistical code Id, refers to a Statistical code reference record",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"tags": {
"description": "arbitrary tags associated with this item",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last checked in",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time",
"readonly": true
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"staffMemberId": {
"type": "string",
"description": "ID a staff member who scanned the item",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
},
"additionalProperties": false,
"required": [
"materialType",
"permanentLoanType",
"status"
]
}
},
"totalRecords": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"items",
"totalRecords"
]
}Example:
{
"items": [
{
"id": "43ec57e3-3974-4d05-a2c2-95126e087b72",
"title": "Nod",
"barcode": "456743454532",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"permanentLoanType": {
"id": "11477028-d9e6-44d2-9364-5c6f51053f51",
"name": "Reading Room"
},
"tags" : {
"tagList" : [
"important"
]
}
},
{
"id": "0b96a642-5e7f-452d-9cae-9cee66c9a892",
"title": "Uprooted",
"callNumber": "D11.J54 A3 2011",
"barcode": "645398607547",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLoanType": {
"id": "8e570d0d-931c-43d1-9ca1-221e693ea8d2",
"name": "Can Circulate"
},
"temporaryLoanType": {
"id": "74c25903-4019-4d8a-9360-5cb7761f44e5",
"name": "Course Reserve"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"temporaryLocation": {
"id": "0df935eb-f3f4-4741-9ac6-33c500174b96",
"name": "Annex"
},
"tags" : {
"tagList" : [
"important"
]
}
}
],
"totalRecords": 2
}
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
unable to list items -- malformed parameter 'query', syntax error at column 6HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to list items -- unauthorizedHTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorpost /inventory/items
Create a new item item.
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An item record",
"type": "object",
"properties": {
"id": {
"description": "Item id",
"type": "string"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"description": "ID of the holdings record the item is a member of",
"type": "string"
},
"order": {
"type": "integer",
"description": "Order of the item in the holdings record."
},
"formerIds": {
"type": "array",
"description": "Previous identifiers assigned to the item",
"items": {
"type": "string"
},
"uniqueItems": true
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"displaySummary": {
"description": "Display summary about the item",
"type": "string"
},
"title": {
"type": "string",
"description": "Resouce title (read only, inherited from associated instance record)",
"readonly": true
},
"contributorNames": {
"description": "A list of contributor names",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The contributor name",
"type": "string"
}
}
}
},
"additionalCallNumbers": {
"description": "Additional Call Numbers to track the history of identifiers assigned to an item.",
"type": "array",
"items": {
"type": "object",
"uniqueItems": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An additional call number",
"properties": {
"typeId": {
"type": "string",
"description": "unique ID for the type of call number, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"prefix": {
"type": "string",
"description": "Prefix of the call number."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item or holding, usually printed on a label attached to the item."
},
"suffix": {
"type": "string",
"description": "Suffix of the call number."
}
},
"required": [
"callNumber"
]
}
},
"callNumber": {
"type": "string",
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record)",
"readonly": true
},
"barcode": {
"description": "Text, with input likely validated by the barcode scanner",
"type": "string"
},
"effectiveShelvingOrder": {
"type": "string",
"description": "A system generated normalization of the call number that allows for call number sorting in reports and search results",
"readonly": true
},
"accessionNumber": {
"type": "string",
"description": "Accession number is also called inventar number. Accession number is a unique number assigned to an item in the order in which it is added to a library collection. Most libraries assign accession numbers in continous numerical sequece, but some use a code system to indicate type of material and/or year of accession in addition to order of accession"
},
"itemLevelCallNumber": {
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record). The item level call number, is the call number on item level",
"type": "string"
},
"itemLevelCallNumberPrefix": {
"description": "Prefix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberSuffix": {
"description": "Suffix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberTypeId": {
"description": "Call number type, refers to a call-number-type reference record",
"type": "string"
},
"effectiveCallNumberComponents": {
"type": "object",
"description": "Elements of a full call number generated from the item or holding",
"properties": {
"callNumber": {
"type": "string",
"description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"prefix": {
"type": "string",
"description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"suffix": {
"type": "string",
"description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"typeId": {
"type": "string",
"description": "Effective Call Number Type Id is the call number type id assigned to the item or associated holding.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"volume": {
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of Gerorge Bernard Shaw in three volumes)",
"type": "string"
},
"enumeration": {
"description": "Enumeration is the descriptive information for the numbering scheme of a serial, usually identified by level and a descriptive caption, e.g., level 0 = v. and level 1 = no. This means that each issue of the serial has a volume and an issue number that would appear (e.g. v.71:no.6-2)",
"type": "string"
},
"chronology": {
"description": "Chronology is the descriptive information for the dating scheme of a serial, usually identified by level, e.g., level 0 = year level 1 = month. This means that each issue of the serial has a month and a year on each issue (e.g. 1985:July-Dec.)",
"type": "string"
},
"yearCaption": {
"description": "In multipart monographs, a caption is characters used to label a level of chronology (e.g. 'year 1985')",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"description": "Item identifier number, e.g. imported from the union catalogue (read only)",
"type": "string"
},
"copyNumber": {
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; a copy of a multi-volume, (e.g. Copy 1, or C.7.)",
"type": "string"
},
"numberOfPieces": {
"description": "Number of pieces. Used when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set)",
"type": "string"
},
"descriptionOfPieces": {
"description": "Text which descripe the pieces",
"type": "string"
},
"numberOfMissingPieces": {
"description": "Number of missing pieces",
"type": "string"
},
"missingPieces": {
"description": "Text which descripes the missing pieces",
"type": "string"
},
"missingPiecesDate": {
"description": "Date when the piece(s) went missing",
"type": "string"
},
"itemDamagedStatusId": {
"description": "Item Damage status Id, refers to an Item damage Status ID reference record",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date when damage status was last changed",
"type": "string"
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"description": "notes",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Note for item record",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.ItemNotes",
"additionalProperties": false,
"properties": {
"itemNoteTypeId": {
"description": "Item note type, refers to a item-note-type reference record",
"type": "string"
},
"note": {
"description": "Text to display (e.g. action note, binding, use and reproduction)",
"type": "string"
},
"staffOnly": {
"description": "Records the fact that the record should only be displayed for staff",
"type": "boolean",
"default": false
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"noteType": {
"type": "string",
"description": "Type of circulation process that the note applies to",
"enum": [
"Check in",
"Check out"
]
},
"note": {
"type": "string",
"description": "Text to display"
},
"staffOnly": {
"type": "boolean",
"description": "Records the fact that the note should only be displayed for staff",
"default": false
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting.",
"readonly": true,
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note",
"readonly": true
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"readonly": true,
"properties": {
"lastName": {
"type": "string",
"description": "The user's last name",
"readonly": true
},
"firstName": {
"type": "string",
"description": "The user's first name",
"readonly": true
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting.",
"readonly": true
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the item state (e.g. Available, Checked out, In transit, Awaiting pickup, On order). Default value is set to: Available",
"type": "string",
"enum": [
"Aged to lost",
"Available",
"Awaiting delivery",
"Awaiting pickup",
"Checked out",
"Claimed returned",
"Declared lost",
"Lost and paid",
"Long missing",
"Missing",
"In process",
"In process (non-requestable)",
"In transit",
"Intellectual item",
"On order",
"Order closed",
"Paged",
"Restricted",
"Unavailable",
"Unknown",
"Withdrawn"
]
},
"date": {
"description": "Date of the current item state. E.g. date set when item state was changed by the Check out app",
"type": "string",
"readonly": true,
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"materialType": {
"description": "Material type define what type of thing the item is",
"type": "object",
"properties": {
"id": {
"description": "Material type Id, refers to a material type reference record",
"type": "string"
},
"name": {
"description": "Material type name (e.g. Audio book, Audio disc, Computer file, Pamphelet) ",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"isBoundWith": {
"description": "Indicates if this Item is a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"boundWithTitles": {
"description": "List of titles that are bound together within this Item",
"type": "array",
"items": {
"type": "object",
"description": "A title that is bound with other titles within this Item",
"properties": {
"briefHoldingsRecord": {
"type": "object",
"description": "Information about a holdings record that links a title to the bound-with Item",
"properties": {
"id": {
"description": "The UUID of the holdingsRecord",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the holdingsRecord",
"type": "string"
}
},
"additionalProperties": false
},
"briefInstance": {
"type": "object",
"description": "Information about an Instance / title that is bound with other title within this Item",
"properties": {
"id": {
"description": "The UUID of the Instance",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the Instance",
"type": "string"
},
"title": {
"description": "The title of the Instance",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"readonly": true
},
"permanentLoanType": {
"description": "Permanent loan type, is the default loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Permanent loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Permanent loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLoanType": {
"description": "Temporary loan type, is the temporary loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Temporary loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Temporary loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"permanentLocation": {
"description": "Permanent item location is the default location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Permanent location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Permanent location type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLocation": {
"description": "Temporary item location is the temporarily location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Temporary location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Temporary location name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"effectiveLocation": {
"type": "object",
"description": "The effective location is used by FOLIO and other integrated systems to know the current home location for the item (read only, derived from locations on HoldingsRecord and Item)",
"readonly": true,
"properties": {
"id": {
"type": "string",
"readonly": true
},
"name": {
"description": "Effective location name",
"type": "string",
"readonly": true
}
}
},
"electronicAccess": {
"description": "Whether an item is available electronically",
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "Link text is used for display in place of the URL"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id, refers to a Relationship type reference record. Relationship between the electronic resource at the location identified and the item described in the record as a whole. (E.g. values from MARC 21, tag field 856 2nd indicator, where the values are: No information provided, Resource, Version of resource, Related resource, No display constant generate"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "Statistical code Id, refers to a Statistical code reference record",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"tags": {
"description": "arbitrary tags associated with this item",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last checked in",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time",
"readonly": true
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"staffMemberId": {
"type": "string",
"description": "ID a staff member who scanned the item",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
},
"additionalProperties": false,
"required": [
"materialType",
"permanentLoanType",
"status"
]
}Example:
{
"id": "0b96a642-5e7f-452d-9cae-9cee66c9a892",
"title": "Uprooted",
"contributorNames": [{ "name": "Novik, Naomi" }],
"callNumber": "D11.J54 A3 2011",
"barcode": "645398607547",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLoanType": {
"id": "8e570d0d-931c-43d1-9ca1-221e693ea8d2",
"name": "Can Circulate"
},
"temporaryLoanType": {
"id": "74c25903-4019-4d8a-9360-5cb7761f44e5",
"name": "Course Reserve"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"inTransitDestinationServicePointId": "5b31ec8c-95a7-4b91-95cc-b551a74b91ca",
"tags" : {
"tagList" : [
"important"
]
}
}
HTTP status code 201
Returns a newly created item, with server-controlled fields like 'id' populated
Headers
- Location: required(string)
URI to the created item item
Body
Media type: application/json
Type: any
Example:
{
"id": "0b96a642-5e7f-452d-9cae-9cee66c9a892",
"title": "Uprooted",
"contributorNames": [{ "name": "Novik, Naomi" }],
"callNumber": "D11.J54 A3 2011",
"barcode": "645398607547",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLoanType": {
"id": "8e570d0d-931c-43d1-9ca1-221e693ea8d2",
"name": "Can Circulate"
},
"temporaryLoanType": {
"id": "74c25903-4019-4d8a-9360-5cb7761f44e5",
"name": "Course Reserve"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"inTransitDestinationServicePointId": "5b31ec8c-95a7-4b91-95cc-b551a74b91ca",
"tags" : {
"tagList" : [
"important"
]
}
}
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to add item -- malformed JSON at 13:3"
HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to create items -- unauthorizedHTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administratordelete /inventory/items
Query Parameters
- query: (string)
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
CQL to select items to delete, use cql.allRecords=1 to delete all
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode barcode=="123-0*" - lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 204
Selected items deleted
HTTP status code 400
Bad request, e.g. malformed query parameter
Body
Media type: text/plain
Type: any
Example:
query parameter is emptyHTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorpost
Fetch inventory items collection by POST request
post /inventory/items/retrieve
Fetch inventory items collection by POST request
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "DTO for fetching records by POST request",
"type": "object",
"properties": {
"offset": {
"description": "Skip over a number of elements by specifying an offset value for the query",
"type": "integer",
"minimum": 0,
"maximum": 2147483647,
"default": 0
},
"limit": {
"description": "Limit the number of elements returned in the response",
"type": "integer",
"minimum": 0,
"maximum": 2147483647,
"default": 10
},
"query": {
"description": "A query expressed as a CQL string",
"type": "string"
}
}
}Example:
{
"limit": 10,
"offset": 10,
"query": "id=\"32a5ccd3-d5f0-4095-a646-6bc764cf2e59\""
}
HTTP status code 422
Validation errors
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Entity representing a item
get
Retrieve item item with given {itemId}
delete
Delete item item with given {itemId}
put
Update item item with given {itemId}
get /inventory/items/{itemId}
Retrieve item item with given {itemId}
URI Parameters
- itemId: required(string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 200
Returns item with a given ID
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An item record",
"type": "object",
"properties": {
"id": {
"description": "Item id",
"type": "string"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"description": "ID of the holdings record the item is a member of",
"type": "string"
},
"order": {
"type": "integer",
"description": "Order of the item in the holdings record."
},
"formerIds": {
"type": "array",
"description": "Previous identifiers assigned to the item",
"items": {
"type": "string"
},
"uniqueItems": true
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"displaySummary": {
"description": "Display summary about the item",
"type": "string"
},
"title": {
"type": "string",
"description": "Resouce title (read only, inherited from associated instance record)",
"readonly": true
},
"contributorNames": {
"description": "A list of contributor names",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The contributor name",
"type": "string"
}
}
}
},
"additionalCallNumbers": {
"description": "Additional Call Numbers to track the history of identifiers assigned to an item.",
"type": "array",
"items": {
"type": "object",
"uniqueItems": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An additional call number",
"properties": {
"typeId": {
"type": "string",
"description": "unique ID for the type of call number, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"prefix": {
"type": "string",
"description": "Prefix of the call number."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item or holding, usually printed on a label attached to the item."
},
"suffix": {
"type": "string",
"description": "Suffix of the call number."
}
},
"required": [
"callNumber"
]
}
},
"callNumber": {
"type": "string",
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record)",
"readonly": true
},
"barcode": {
"description": "Text, with input likely validated by the barcode scanner",
"type": "string"
},
"effectiveShelvingOrder": {
"type": "string",
"description": "A system generated normalization of the call number that allows for call number sorting in reports and search results",
"readonly": true
},
"accessionNumber": {
"type": "string",
"description": "Accession number is also called inventar number. Accession number is a unique number assigned to an item in the order in which it is added to a library collection. Most libraries assign accession numbers in continous numerical sequece, but some use a code system to indicate type of material and/or year of accession in addition to order of accession"
},
"itemLevelCallNumber": {
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record). The item level call number, is the call number on item level",
"type": "string"
},
"itemLevelCallNumberPrefix": {
"description": "Prefix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberSuffix": {
"description": "Suffix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberTypeId": {
"description": "Call number type, refers to a call-number-type reference record",
"type": "string"
},
"effectiveCallNumberComponents": {
"type": "object",
"description": "Elements of a full call number generated from the item or holding",
"properties": {
"callNumber": {
"type": "string",
"description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"prefix": {
"type": "string",
"description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"suffix": {
"type": "string",
"description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"typeId": {
"type": "string",
"description": "Effective Call Number Type Id is the call number type id assigned to the item or associated holding.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"volume": {
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of Gerorge Bernard Shaw in three volumes)",
"type": "string"
},
"enumeration": {
"description": "Enumeration is the descriptive information for the numbering scheme of a serial, usually identified by level and a descriptive caption, e.g., level 0 = v. and level 1 = no. This means that each issue of the serial has a volume and an issue number that would appear (e.g. v.71:no.6-2)",
"type": "string"
},
"chronology": {
"description": "Chronology is the descriptive information for the dating scheme of a serial, usually identified by level, e.g., level 0 = year level 1 = month. This means that each issue of the serial has a month and a year on each issue (e.g. 1985:July-Dec.)",
"type": "string"
},
"yearCaption": {
"description": "In multipart monographs, a caption is characters used to label a level of chronology (e.g. 'year 1985')",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"description": "Item identifier number, e.g. imported from the union catalogue (read only)",
"type": "string"
},
"copyNumber": {
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; a copy of a multi-volume, (e.g. Copy 1, or C.7.)",
"type": "string"
},
"numberOfPieces": {
"description": "Number of pieces. Used when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set)",
"type": "string"
},
"descriptionOfPieces": {
"description": "Text which descripe the pieces",
"type": "string"
},
"numberOfMissingPieces": {
"description": "Number of missing pieces",
"type": "string"
},
"missingPieces": {
"description": "Text which descripes the missing pieces",
"type": "string"
},
"missingPiecesDate": {
"description": "Date when the piece(s) went missing",
"type": "string"
},
"itemDamagedStatusId": {
"description": "Item Damage status Id, refers to an Item damage Status ID reference record",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date when damage status was last changed",
"type": "string"
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"description": "notes",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Note for item record",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.ItemNotes",
"additionalProperties": false,
"properties": {
"itemNoteTypeId": {
"description": "Item note type, refers to a item-note-type reference record",
"type": "string"
},
"note": {
"description": "Text to display (e.g. action note, binding, use and reproduction)",
"type": "string"
},
"staffOnly": {
"description": "Records the fact that the record should only be displayed for staff",
"type": "boolean",
"default": false
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"noteType": {
"type": "string",
"description": "Type of circulation process that the note applies to",
"enum": [
"Check in",
"Check out"
]
},
"note": {
"type": "string",
"description": "Text to display"
},
"staffOnly": {
"type": "boolean",
"description": "Records the fact that the note should only be displayed for staff",
"default": false
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting.",
"readonly": true,
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note",
"readonly": true
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"readonly": true,
"properties": {
"lastName": {
"type": "string",
"description": "The user's last name",
"readonly": true
},
"firstName": {
"type": "string",
"description": "The user's first name",
"readonly": true
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting.",
"readonly": true
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the item state (e.g. Available, Checked out, In transit, Awaiting pickup, On order). Default value is set to: Available",
"type": "string",
"enum": [
"Aged to lost",
"Available",
"Awaiting delivery",
"Awaiting pickup",
"Checked out",
"Claimed returned",
"Declared lost",
"Lost and paid",
"Long missing",
"Missing",
"In process",
"In process (non-requestable)",
"In transit",
"Intellectual item",
"On order",
"Order closed",
"Paged",
"Restricted",
"Unavailable",
"Unknown",
"Withdrawn"
]
},
"date": {
"description": "Date of the current item state. E.g. date set when item state was changed by the Check out app",
"type": "string",
"readonly": true,
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"materialType": {
"description": "Material type define what type of thing the item is",
"type": "object",
"properties": {
"id": {
"description": "Material type Id, refers to a material type reference record",
"type": "string"
},
"name": {
"description": "Material type name (e.g. Audio book, Audio disc, Computer file, Pamphelet) ",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"isBoundWith": {
"description": "Indicates if this Item is a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"boundWithTitles": {
"description": "List of titles that are bound together within this Item",
"type": "array",
"items": {
"type": "object",
"description": "A title that is bound with other titles within this Item",
"properties": {
"briefHoldingsRecord": {
"type": "object",
"description": "Information about a holdings record that links a title to the bound-with Item",
"properties": {
"id": {
"description": "The UUID of the holdingsRecord",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the holdingsRecord",
"type": "string"
}
},
"additionalProperties": false
},
"briefInstance": {
"type": "object",
"description": "Information about an Instance / title that is bound with other title within this Item",
"properties": {
"id": {
"description": "The UUID of the Instance",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the Instance",
"type": "string"
},
"title": {
"description": "The title of the Instance",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"readonly": true
},
"permanentLoanType": {
"description": "Permanent loan type, is the default loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Permanent loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Permanent loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLoanType": {
"description": "Temporary loan type, is the temporary loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Temporary loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Temporary loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"permanentLocation": {
"description": "Permanent item location is the default location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Permanent location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Permanent location type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLocation": {
"description": "Temporary item location is the temporarily location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Temporary location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Temporary location name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"effectiveLocation": {
"type": "object",
"description": "The effective location is used by FOLIO and other integrated systems to know the current home location for the item (read only, derived from locations on HoldingsRecord and Item)",
"readonly": true,
"properties": {
"id": {
"type": "string",
"readonly": true
},
"name": {
"description": "Effective location name",
"type": "string",
"readonly": true
}
}
},
"electronicAccess": {
"description": "Whether an item is available electronically",
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "Link text is used for display in place of the URL"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id, refers to a Relationship type reference record. Relationship between the electronic resource at the location identified and the item described in the record as a whole. (E.g. values from MARC 21, tag field 856 2nd indicator, where the values are: No information provided, Resource, Version of resource, Related resource, No display constant generate"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "Statistical code Id, refers to a Statistical code reference record",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"tags": {
"description": "arbitrary tags associated with this item",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last checked in",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time",
"readonly": true
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"staffMemberId": {
"type": "string",
"description": "ID a staff member who scanned the item",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
},
"additionalProperties": false,
"required": [
"materialType",
"permanentLoanType",
"status"
]
}Example:
{
"id": "0b96a642-5e7f-452d-9cae-9cee66c9a892",
"title": "Uprooted",
"contributorNames": [{ "name": "Novik, Naomi" }],
"callNumber": "D11.J54 A3 2011",
"barcode": "645398607547",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLoanType": {
"id": "8e570d0d-931c-43d1-9ca1-221e693ea8d2",
"name": "Can Circulate"
},
"temporaryLoanType": {
"id": "74c25903-4019-4d8a-9360-5cb7761f44e5",
"name": "Course Reserve"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"inTransitDestinationServicePointId": "5b31ec8c-95a7-4b91-95cc-b551a74b91ca",
"tags" : {
"tagList" : [
"important"
]
}
}
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"item not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratordelete /inventory/items/{itemId}
Delete item item with given {itemId}
URI Parameters
- itemId: required(string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 204
Item deleted successfully
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to delete item -- constraint violation"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"item not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorput /inventory/items/{itemId}
Update item item with given {itemId}
URI Parameters
- itemId: required(string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An item record",
"type": "object",
"properties": {
"id": {
"description": "Item id",
"type": "string"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"description": "ID of the holdings record the item is a member of",
"type": "string"
},
"order": {
"type": "integer",
"description": "Order of the item in the holdings record."
},
"formerIds": {
"type": "array",
"description": "Previous identifiers assigned to the item",
"items": {
"type": "string"
},
"uniqueItems": true
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"displaySummary": {
"description": "Display summary about the item",
"type": "string"
},
"title": {
"type": "string",
"description": "Resouce title (read only, inherited from associated instance record)",
"readonly": true
},
"contributorNames": {
"description": "A list of contributor names",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The contributor name",
"type": "string"
}
}
}
},
"additionalCallNumbers": {
"description": "Additional Call Numbers to track the history of identifiers assigned to an item.",
"type": "array",
"items": {
"type": "object",
"uniqueItems": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An additional call number",
"properties": {
"typeId": {
"type": "string",
"description": "unique ID for the type of call number, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"prefix": {
"type": "string",
"description": "Prefix of the call number."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item or holding, usually printed on a label attached to the item."
},
"suffix": {
"type": "string",
"description": "Suffix of the call number."
}
},
"required": [
"callNumber"
]
}
},
"callNumber": {
"type": "string",
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record)",
"readonly": true
},
"barcode": {
"description": "Text, with input likely validated by the barcode scanner",
"type": "string"
},
"effectiveShelvingOrder": {
"type": "string",
"description": "A system generated normalization of the call number that allows for call number sorting in reports and search results",
"readonly": true
},
"accessionNumber": {
"type": "string",
"description": "Accession number is also called inventar number. Accession number is a unique number assigned to an item in the order in which it is added to a library collection. Most libraries assign accession numbers in continous numerical sequece, but some use a code system to indicate type of material and/or year of accession in addition to order of accession"
},
"itemLevelCallNumber": {
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record). The item level call number, is the call number on item level",
"type": "string"
},
"itemLevelCallNumberPrefix": {
"description": "Prefix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberSuffix": {
"description": "Suffix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberTypeId": {
"description": "Call number type, refers to a call-number-type reference record",
"type": "string"
},
"effectiveCallNumberComponents": {
"type": "object",
"description": "Elements of a full call number generated from the item or holding",
"properties": {
"callNumber": {
"type": "string",
"description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"prefix": {
"type": "string",
"description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"suffix": {
"type": "string",
"description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"typeId": {
"type": "string",
"description": "Effective Call Number Type Id is the call number type id assigned to the item or associated holding.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"volume": {
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of Gerorge Bernard Shaw in three volumes)",
"type": "string"
},
"enumeration": {
"description": "Enumeration is the descriptive information for the numbering scheme of a serial, usually identified by level and a descriptive caption, e.g., level 0 = v. and level 1 = no. This means that each issue of the serial has a volume and an issue number that would appear (e.g. v.71:no.6-2)",
"type": "string"
},
"chronology": {
"description": "Chronology is the descriptive information for the dating scheme of a serial, usually identified by level, e.g., level 0 = year level 1 = month. This means that each issue of the serial has a month and a year on each issue (e.g. 1985:July-Dec.)",
"type": "string"
},
"yearCaption": {
"description": "In multipart monographs, a caption is characters used to label a level of chronology (e.g. 'year 1985')",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"description": "Item identifier number, e.g. imported from the union catalogue (read only)",
"type": "string"
},
"copyNumber": {
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; a copy of a multi-volume, (e.g. Copy 1, or C.7.)",
"type": "string"
},
"numberOfPieces": {
"description": "Number of pieces. Used when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set)",
"type": "string"
},
"descriptionOfPieces": {
"description": "Text which descripe the pieces",
"type": "string"
},
"numberOfMissingPieces": {
"description": "Number of missing pieces",
"type": "string"
},
"missingPieces": {
"description": "Text which descripes the missing pieces",
"type": "string"
},
"missingPiecesDate": {
"description": "Date when the piece(s) went missing",
"type": "string"
},
"itemDamagedStatusId": {
"description": "Item Damage status Id, refers to an Item damage Status ID reference record",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date when damage status was last changed",
"type": "string"
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"description": "notes",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Note for item record",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.ItemNotes",
"additionalProperties": false,
"properties": {
"itemNoteTypeId": {
"description": "Item note type, refers to a item-note-type reference record",
"type": "string"
},
"note": {
"description": "Text to display (e.g. action note, binding, use and reproduction)",
"type": "string"
},
"staffOnly": {
"description": "Records the fact that the record should only be displayed for staff",
"type": "boolean",
"default": false
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"noteType": {
"type": "string",
"description": "Type of circulation process that the note applies to",
"enum": [
"Check in",
"Check out"
]
},
"note": {
"type": "string",
"description": "Text to display"
},
"staffOnly": {
"type": "boolean",
"description": "Records the fact that the note should only be displayed for staff",
"default": false
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting.",
"readonly": true,
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note",
"readonly": true
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"readonly": true,
"properties": {
"lastName": {
"type": "string",
"description": "The user's last name",
"readonly": true
},
"firstName": {
"type": "string",
"description": "The user's first name",
"readonly": true
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting.",
"readonly": true
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the item state (e.g. Available, Checked out, In transit, Awaiting pickup, On order). Default value is set to: Available",
"type": "string",
"enum": [
"Aged to lost",
"Available",
"Awaiting delivery",
"Awaiting pickup",
"Checked out",
"Claimed returned",
"Declared lost",
"Lost and paid",
"Long missing",
"Missing",
"In process",
"In process (non-requestable)",
"In transit",
"Intellectual item",
"On order",
"Order closed",
"Paged",
"Restricted",
"Unavailable",
"Unknown",
"Withdrawn"
]
},
"date": {
"description": "Date of the current item state. E.g. date set when item state was changed by the Check out app",
"type": "string",
"readonly": true,
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"materialType": {
"description": "Material type define what type of thing the item is",
"type": "object",
"properties": {
"id": {
"description": "Material type Id, refers to a material type reference record",
"type": "string"
},
"name": {
"description": "Material type name (e.g. Audio book, Audio disc, Computer file, Pamphelet) ",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"isBoundWith": {
"description": "Indicates if this Item is a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"boundWithTitles": {
"description": "List of titles that are bound together within this Item",
"type": "array",
"items": {
"type": "object",
"description": "A title that is bound with other titles within this Item",
"properties": {
"briefHoldingsRecord": {
"type": "object",
"description": "Information about a holdings record that links a title to the bound-with Item",
"properties": {
"id": {
"description": "The UUID of the holdingsRecord",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the holdingsRecord",
"type": "string"
}
},
"additionalProperties": false
},
"briefInstance": {
"type": "object",
"description": "Information about an Instance / title that is bound with other title within this Item",
"properties": {
"id": {
"description": "The UUID of the Instance",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the Instance",
"type": "string"
},
"title": {
"description": "The title of the Instance",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"readonly": true
},
"permanentLoanType": {
"description": "Permanent loan type, is the default loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Permanent loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Permanent loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLoanType": {
"description": "Temporary loan type, is the temporary loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Temporary loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Temporary loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"permanentLocation": {
"description": "Permanent item location is the default location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Permanent location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Permanent location type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLocation": {
"description": "Temporary item location is the temporarily location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Temporary location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Temporary location name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"effectiveLocation": {
"type": "object",
"description": "The effective location is used by FOLIO and other integrated systems to know the current home location for the item (read only, derived from locations on HoldingsRecord and Item)",
"readonly": true,
"properties": {
"id": {
"type": "string",
"readonly": true
},
"name": {
"description": "Effective location name",
"type": "string",
"readonly": true
}
}
},
"electronicAccess": {
"description": "Whether an item is available electronically",
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "Link text is used for display in place of the URL"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id, refers to a Relationship type reference record. Relationship between the electronic resource at the location identified and the item described in the record as a whole. (E.g. values from MARC 21, tag field 856 2nd indicator, where the values are: No information provided, Resource, Version of resource, Related resource, No display constant generate"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "Statistical code Id, refers to a Statistical code reference record",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"tags": {
"description": "arbitrary tags associated with this item",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last checked in",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time",
"readonly": true
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"staffMemberId": {
"type": "string",
"description": "ID a staff member who scanned the item",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
},
"additionalProperties": false,
"required": [
"materialType",
"permanentLoanType",
"status"
]
}Example:
{
"id": "0b96a642-5e7f-452d-9cae-9cee66c9a892",
"title": "Uprooted",
"contributorNames": [{ "name": "Novik, Naomi" }],
"callNumber": "D11.J54 A3 2011",
"barcode": "645398607547",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLoanType": {
"id": "8e570d0d-931c-43d1-9ca1-221e693ea8d2",
"name": "Can Circulate"
},
"temporaryLoanType": {
"id": "74c25903-4019-4d8a-9360-5cb7761f44e5",
"name": "Course Reserve"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"inTransitDestinationServicePointId": "5b31ec8c-95a7-4b91-95cc-b551a74b91ca",
"tags" : {
"tagList" : [
"important"
]
}
}
HTTP status code 204
Item successfully updated
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to update item -- malformed JSON at 13:4"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"item not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorpost
post /inventory/items/{itemId}/mark-withdrawn
URI Parameters
- itemId: required(string)
HTTP status code 201
Item has marked as withdrawn
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An item record",
"type": "object",
"properties": {
"id": {
"description": "Item id",
"type": "string"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"description": "ID of the holdings record the item is a member of",
"type": "string"
},
"order": {
"type": "integer",
"description": "Order of the item in the holdings record."
},
"formerIds": {
"type": "array",
"description": "Previous identifiers assigned to the item",
"items": {
"type": "string"
},
"uniqueItems": true
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"displaySummary": {
"description": "Display summary about the item",
"type": "string"
},
"title": {
"type": "string",
"description": "Resouce title (read only, inherited from associated instance record)",
"readonly": true
},
"contributorNames": {
"description": "A list of contributor names",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The contributor name",
"type": "string"
}
}
}
},
"additionalCallNumbers": {
"description": "Additional Call Numbers to track the history of identifiers assigned to an item.",
"type": "array",
"items": {
"type": "object",
"uniqueItems": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An additional call number",
"properties": {
"typeId": {
"type": "string",
"description": "unique ID for the type of call number, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"prefix": {
"type": "string",
"description": "Prefix of the call number."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item or holding, usually printed on a label attached to the item."
},
"suffix": {
"type": "string",
"description": "Suffix of the call number."
}
},
"required": [
"callNumber"
]
}
},
"callNumber": {
"type": "string",
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record)",
"readonly": true
},
"barcode": {
"description": "Text, with input likely validated by the barcode scanner",
"type": "string"
},
"effectiveShelvingOrder": {
"type": "string",
"description": "A system generated normalization of the call number that allows for call number sorting in reports and search results",
"readonly": true
},
"accessionNumber": {
"type": "string",
"description": "Accession number is also called inventar number. Accession number is a unique number assigned to an item in the order in which it is added to a library collection. Most libraries assign accession numbers in continous numerical sequece, but some use a code system to indicate type of material and/or year of accession in addition to order of accession"
},
"itemLevelCallNumber": {
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record). The item level call number, is the call number on item level",
"type": "string"
},
"itemLevelCallNumberPrefix": {
"description": "Prefix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberSuffix": {
"description": "Suffix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberTypeId": {
"description": "Call number type, refers to a call-number-type reference record",
"type": "string"
},
"effectiveCallNumberComponents": {
"type": "object",
"description": "Elements of a full call number generated from the item or holding",
"properties": {
"callNumber": {
"type": "string",
"description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"prefix": {
"type": "string",
"description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"suffix": {
"type": "string",
"description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"typeId": {
"type": "string",
"description": "Effective Call Number Type Id is the call number type id assigned to the item or associated holding.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"volume": {
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of Gerorge Bernard Shaw in three volumes)",
"type": "string"
},
"enumeration": {
"description": "Enumeration is the descriptive information for the numbering scheme of a serial, usually identified by level and a descriptive caption, e.g., level 0 = v. and level 1 = no. This means that each issue of the serial has a volume and an issue number that would appear (e.g. v.71:no.6-2)",
"type": "string"
},
"chronology": {
"description": "Chronology is the descriptive information for the dating scheme of a serial, usually identified by level, e.g., level 0 = year level 1 = month. This means that each issue of the serial has a month and a year on each issue (e.g. 1985:July-Dec.)",
"type": "string"
},
"yearCaption": {
"description": "In multipart monographs, a caption is characters used to label a level of chronology (e.g. 'year 1985')",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"description": "Item identifier number, e.g. imported from the union catalogue (read only)",
"type": "string"
},
"copyNumber": {
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; a copy of a multi-volume, (e.g. Copy 1, or C.7.)",
"type": "string"
},
"numberOfPieces": {
"description": "Number of pieces. Used when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set)",
"type": "string"
},
"descriptionOfPieces": {
"description": "Text which descripe the pieces",
"type": "string"
},
"numberOfMissingPieces": {
"description": "Number of missing pieces",
"type": "string"
},
"missingPieces": {
"description": "Text which descripes the missing pieces",
"type": "string"
},
"missingPiecesDate": {
"description": "Date when the piece(s) went missing",
"type": "string"
},
"itemDamagedStatusId": {
"description": "Item Damage status Id, refers to an Item damage Status ID reference record",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date when damage status was last changed",
"type": "string"
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"description": "notes",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Note for item record",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.ItemNotes",
"additionalProperties": false,
"properties": {
"itemNoteTypeId": {
"description": "Item note type, refers to a item-note-type reference record",
"type": "string"
},
"note": {
"description": "Text to display (e.g. action note, binding, use and reproduction)",
"type": "string"
},
"staffOnly": {
"description": "Records the fact that the record should only be displayed for staff",
"type": "boolean",
"default": false
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"noteType": {
"type": "string",
"description": "Type of circulation process that the note applies to",
"enum": [
"Check in",
"Check out"
]
},
"note": {
"type": "string",
"description": "Text to display"
},
"staffOnly": {
"type": "boolean",
"description": "Records the fact that the note should only be displayed for staff",
"default": false
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting.",
"readonly": true,
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note",
"readonly": true
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"readonly": true,
"properties": {
"lastName": {
"type": "string",
"description": "The user's last name",
"readonly": true
},
"firstName": {
"type": "string",
"description": "The user's first name",
"readonly": true
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting.",
"readonly": true
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the item state (e.g. Available, Checked out, In transit, Awaiting pickup, On order). Default value is set to: Available",
"type": "string",
"enum": [
"Aged to lost",
"Available",
"Awaiting delivery",
"Awaiting pickup",
"Checked out",
"Claimed returned",
"Declared lost",
"Lost and paid",
"Long missing",
"Missing",
"In process",
"In process (non-requestable)",
"In transit",
"Intellectual item",
"On order",
"Order closed",
"Paged",
"Restricted",
"Unavailable",
"Unknown",
"Withdrawn"
]
},
"date": {
"description": "Date of the current item state. E.g. date set when item state was changed by the Check out app",
"type": "string",
"readonly": true,
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"materialType": {
"description": "Material type define what type of thing the item is",
"type": "object",
"properties": {
"id": {
"description": "Material type Id, refers to a material type reference record",
"type": "string"
},
"name": {
"description": "Material type name (e.g. Audio book, Audio disc, Computer file, Pamphelet) ",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"isBoundWith": {
"description": "Indicates if this Item is a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"boundWithTitles": {
"description": "List of titles that are bound together within this Item",
"type": "array",
"items": {
"type": "object",
"description": "A title that is bound with other titles within this Item",
"properties": {
"briefHoldingsRecord": {
"type": "object",
"description": "Information about a holdings record that links a title to the bound-with Item",
"properties": {
"id": {
"description": "The UUID of the holdingsRecord",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the holdingsRecord",
"type": "string"
}
},
"additionalProperties": false
},
"briefInstance": {
"type": "object",
"description": "Information about an Instance / title that is bound with other title within this Item",
"properties": {
"id": {
"description": "The UUID of the Instance",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the Instance",
"type": "string"
},
"title": {
"description": "The title of the Instance",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"readonly": true
},
"permanentLoanType": {
"description": "Permanent loan type, is the default loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Permanent loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Permanent loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLoanType": {
"description": "Temporary loan type, is the temporary loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Temporary loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Temporary loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"permanentLocation": {
"description": "Permanent item location is the default location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Permanent location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Permanent location type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLocation": {
"description": "Temporary item location is the temporarily location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Temporary location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Temporary location name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"effectiveLocation": {
"type": "object",
"description": "The effective location is used by FOLIO and other integrated systems to know the current home location for the item (read only, derived from locations on HoldingsRecord and Item)",
"readonly": true,
"properties": {
"id": {
"type": "string",
"readonly": true
},
"name": {
"description": "Effective location name",
"type": "string",
"readonly": true
}
}
},
"electronicAccess": {
"description": "Whether an item is available electronically",
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "Link text is used for display in place of the URL"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id, refers to a Relationship type reference record. Relationship between the electronic resource at the location identified and the item described in the record as a whole. (E.g. values from MARC 21, tag field 856 2nd indicator, where the values are: No information provided, Resource, Version of resource, Related resource, No display constant generate"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "Statistical code Id, refers to a Statistical code reference record",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"tags": {
"description": "arbitrary tags associated with this item",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last checked in",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time",
"readonly": true
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"staffMemberId": {
"type": "string",
"description": "ID a staff member who scanned the item",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
},
"additionalProperties": false,
"required": [
"materialType",
"permanentLoanType",
"status"
]
}Example:
{
"id": "0b96a642-5e7f-452d-9cae-9cee66c9a892",
"title": "Uprooted",
"contributorNames": [{ "name": "Novik, Naomi" }],
"callNumber": "D11.J54 A3 2011",
"barcode": "645398607547",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLoanType": {
"id": "8e570d0d-931c-43d1-9ca1-221e693ea8d2",
"name": "Can Circulate"
},
"temporaryLoanType": {
"id": "74c25903-4019-4d8a-9360-5cb7761f44e5",
"name": "Course Reserve"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"inTransitDestinationServicePointId": "5b31ec8c-95a7-4b91-95cc-b551a74b91ca",
"tags" : {
"tagList" : [
"important"
]
}
}
HTTP status code 404
Item not found
Body
Media type: text/plain
Type: any
Example:
Item with such id not foundHTTP status code 422
Validation error
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server errorpost
post /inventory/items/{itemId}/mark-in-process
URI Parameters
- itemId: required(string)
HTTP status code 200
Item has marked as in process
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An item record",
"type": "object",
"properties": {
"id": {
"description": "Item id",
"type": "string"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"description": "ID of the holdings record the item is a member of",
"type": "string"
},
"order": {
"type": "integer",
"description": "Order of the item in the holdings record."
},
"formerIds": {
"type": "array",
"description": "Previous identifiers assigned to the item",
"items": {
"type": "string"
},
"uniqueItems": true
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"displaySummary": {
"description": "Display summary about the item",
"type": "string"
},
"title": {
"type": "string",
"description": "Resouce title (read only, inherited from associated instance record)",
"readonly": true
},
"contributorNames": {
"description": "A list of contributor names",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The contributor name",
"type": "string"
}
}
}
},
"additionalCallNumbers": {
"description": "Additional Call Numbers to track the history of identifiers assigned to an item.",
"type": "array",
"items": {
"type": "object",
"uniqueItems": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An additional call number",
"properties": {
"typeId": {
"type": "string",
"description": "unique ID for the type of call number, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"prefix": {
"type": "string",
"description": "Prefix of the call number."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item or holding, usually printed on a label attached to the item."
},
"suffix": {
"type": "string",
"description": "Suffix of the call number."
}
},
"required": [
"callNumber"
]
}
},
"callNumber": {
"type": "string",
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record)",
"readonly": true
},
"barcode": {
"description": "Text, with input likely validated by the barcode scanner",
"type": "string"
},
"effectiveShelvingOrder": {
"type": "string",
"description": "A system generated normalization of the call number that allows for call number sorting in reports and search results",
"readonly": true
},
"accessionNumber": {
"type": "string",
"description": "Accession number is also called inventar number. Accession number is a unique number assigned to an item in the order in which it is added to a library collection. Most libraries assign accession numbers in continous numerical sequece, but some use a code system to indicate type of material and/or year of accession in addition to order of accession"
},
"itemLevelCallNumber": {
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record). The item level call number, is the call number on item level",
"type": "string"
},
"itemLevelCallNumberPrefix": {
"description": "Prefix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberSuffix": {
"description": "Suffix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberTypeId": {
"description": "Call number type, refers to a call-number-type reference record",
"type": "string"
},
"effectiveCallNumberComponents": {
"type": "object",
"description": "Elements of a full call number generated from the item or holding",
"properties": {
"callNumber": {
"type": "string",
"description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"prefix": {
"type": "string",
"description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"suffix": {
"type": "string",
"description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"typeId": {
"type": "string",
"description": "Effective Call Number Type Id is the call number type id assigned to the item or associated holding.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"volume": {
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of Gerorge Bernard Shaw in three volumes)",
"type": "string"
},
"enumeration": {
"description": "Enumeration is the descriptive information for the numbering scheme of a serial, usually identified by level and a descriptive caption, e.g., level 0 = v. and level 1 = no. This means that each issue of the serial has a volume and an issue number that would appear (e.g. v.71:no.6-2)",
"type": "string"
},
"chronology": {
"description": "Chronology is the descriptive information for the dating scheme of a serial, usually identified by level, e.g., level 0 = year level 1 = month. This means that each issue of the serial has a month and a year on each issue (e.g. 1985:July-Dec.)",
"type": "string"
},
"yearCaption": {
"description": "In multipart monographs, a caption is characters used to label a level of chronology (e.g. 'year 1985')",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"description": "Item identifier number, e.g. imported from the union catalogue (read only)",
"type": "string"
},
"copyNumber": {
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; a copy of a multi-volume, (e.g. Copy 1, or C.7.)",
"type": "string"
},
"numberOfPieces": {
"description": "Number of pieces. Used when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set)",
"type": "string"
},
"descriptionOfPieces": {
"description": "Text which descripe the pieces",
"type": "string"
},
"numberOfMissingPieces": {
"description": "Number of missing pieces",
"type": "string"
},
"missingPieces": {
"description": "Text which descripes the missing pieces",
"type": "string"
},
"missingPiecesDate": {
"description": "Date when the piece(s) went missing",
"type": "string"
},
"itemDamagedStatusId": {
"description": "Item Damage status Id, refers to an Item damage Status ID reference record",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date when damage status was last changed",
"type": "string"
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"description": "notes",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Note for item record",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.ItemNotes",
"additionalProperties": false,
"properties": {
"itemNoteTypeId": {
"description": "Item note type, refers to a item-note-type reference record",
"type": "string"
},
"note": {
"description": "Text to display (e.g. action note, binding, use and reproduction)",
"type": "string"
},
"staffOnly": {
"description": "Records the fact that the record should only be displayed for staff",
"type": "boolean",
"default": false
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"noteType": {
"type": "string",
"description": "Type of circulation process that the note applies to",
"enum": [
"Check in",
"Check out"
]
},
"note": {
"type": "string",
"description": "Text to display"
},
"staffOnly": {
"type": "boolean",
"description": "Records the fact that the note should only be displayed for staff",
"default": false
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting.",
"readonly": true,
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note",
"readonly": true
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"readonly": true,
"properties": {
"lastName": {
"type": "string",
"description": "The user's last name",
"readonly": true
},
"firstName": {
"type": "string",
"description": "The user's first name",
"readonly": true
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting.",
"readonly": true
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the item state (e.g. Available, Checked out, In transit, Awaiting pickup, On order). Default value is set to: Available",
"type": "string",
"enum": [
"Aged to lost",
"Available",
"Awaiting delivery",
"Awaiting pickup",
"Checked out",
"Claimed returned",
"Declared lost",
"Lost and paid",
"Long missing",
"Missing",
"In process",
"In process (non-requestable)",
"In transit",
"Intellectual item",
"On order",
"Order closed",
"Paged",
"Restricted",
"Unavailable",
"Unknown",
"Withdrawn"
]
},
"date": {
"description": "Date of the current item state. E.g. date set when item state was changed by the Check out app",
"type": "string",
"readonly": true,
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"materialType": {
"description": "Material type define what type of thing the item is",
"type": "object",
"properties": {
"id": {
"description": "Material type Id, refers to a material type reference record",
"type": "string"
},
"name": {
"description": "Material type name (e.g. Audio book, Audio disc, Computer file, Pamphelet) ",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"isBoundWith": {
"description": "Indicates if this Item is a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"boundWithTitles": {
"description": "List of titles that are bound together within this Item",
"type": "array",
"items": {
"type": "object",
"description": "A title that is bound with other titles within this Item",
"properties": {
"briefHoldingsRecord": {
"type": "object",
"description": "Information about a holdings record that links a title to the bound-with Item",
"properties": {
"id": {
"description": "The UUID of the holdingsRecord",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the holdingsRecord",
"type": "string"
}
},
"additionalProperties": false
},
"briefInstance": {
"type": "object",
"description": "Information about an Instance / title that is bound with other title within this Item",
"properties": {
"id": {
"description": "The UUID of the Instance",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the Instance",
"type": "string"
},
"title": {
"description": "The title of the Instance",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"readonly": true
},
"permanentLoanType": {
"description": "Permanent loan type, is the default loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Permanent loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Permanent loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLoanType": {
"description": "Temporary loan type, is the temporary loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Temporary loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Temporary loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"permanentLocation": {
"description": "Permanent item location is the default location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Permanent location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Permanent location type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLocation": {
"description": "Temporary item location is the temporarily location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Temporary location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Temporary location name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"effectiveLocation": {
"type": "object",
"description": "The effective location is used by FOLIO and other integrated systems to know the current home location for the item (read only, derived from locations on HoldingsRecord and Item)",
"readonly": true,
"properties": {
"id": {
"type": "string",
"readonly": true
},
"name": {
"description": "Effective location name",
"type": "string",
"readonly": true
}
}
},
"electronicAccess": {
"description": "Whether an item is available electronically",
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "Link text is used for display in place of the URL"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id, refers to a Relationship type reference record. Relationship between the electronic resource at the location identified and the item described in the record as a whole. (E.g. values from MARC 21, tag field 856 2nd indicator, where the values are: No information provided, Resource, Version of resource, Related resource, No display constant generate"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "Statistical code Id, refers to a Statistical code reference record",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"tags": {
"description": "arbitrary tags associated with this item",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last checked in",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time",
"readonly": true
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"staffMemberId": {
"type": "string",
"description": "ID a staff member who scanned the item",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
},
"additionalProperties": false,
"required": [
"materialType",
"permanentLoanType",
"status"
]
}Example:
{
"id": "0b96a642-5e7f-452d-9cae-9cee66c9a892",
"title": "Uprooted",
"contributorNames": [{ "name": "Novik, Naomi" }],
"callNumber": "D11.J54 A3 2011",
"barcode": "645398607547",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLoanType": {
"id": "8e570d0d-931c-43d1-9ca1-221e693ea8d2",
"name": "Can Circulate"
},
"temporaryLoanType": {
"id": "74c25903-4019-4d8a-9360-5cb7761f44e5",
"name": "Course Reserve"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"inTransitDestinationServicePointId": "5b31ec8c-95a7-4b91-95cc-b551a74b91ca",
"tags" : {
"tagList" : [
"important"
]
}
}
HTTP status code 404
Item not found
Body
Media type: text/plain
Type: any
Example:
Item with such id not foundHTTP status code 422
Validation error
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server errorpost
post /inventory/items/{itemId}/mark-in-process-non-requestable
URI Parameters
- itemId: required(string)
HTTP status code 200
Item has marked as in process (non requestable)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An item record",
"type": "object",
"properties": {
"id": {
"description": "Item id",
"type": "string"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"description": "ID of the holdings record the item is a member of",
"type": "string"
},
"order": {
"type": "integer",
"description": "Order of the item in the holdings record."
},
"formerIds": {
"type": "array",
"description": "Previous identifiers assigned to the item",
"items": {
"type": "string"
},
"uniqueItems": true
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"displaySummary": {
"description": "Display summary about the item",
"type": "string"
},
"title": {
"type": "string",
"description": "Resouce title (read only, inherited from associated instance record)",
"readonly": true
},
"contributorNames": {
"description": "A list of contributor names",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The contributor name",
"type": "string"
}
}
}
},
"additionalCallNumbers": {
"description": "Additional Call Numbers to track the history of identifiers assigned to an item.",
"type": "array",
"items": {
"type": "object",
"uniqueItems": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An additional call number",
"properties": {
"typeId": {
"type": "string",
"description": "unique ID for the type of call number, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"prefix": {
"type": "string",
"description": "Prefix of the call number."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item or holding, usually printed on a label attached to the item."
},
"suffix": {
"type": "string",
"description": "Suffix of the call number."
}
},
"required": [
"callNumber"
]
}
},
"callNumber": {
"type": "string",
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record)",
"readonly": true
},
"barcode": {
"description": "Text, with input likely validated by the barcode scanner",
"type": "string"
},
"effectiveShelvingOrder": {
"type": "string",
"description": "A system generated normalization of the call number that allows for call number sorting in reports and search results",
"readonly": true
},
"accessionNumber": {
"type": "string",
"description": "Accession number is also called inventar number. Accession number is a unique number assigned to an item in the order in which it is added to a library collection. Most libraries assign accession numbers in continous numerical sequece, but some use a code system to indicate type of material and/or year of accession in addition to order of accession"
},
"itemLevelCallNumber": {
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record). The item level call number, is the call number on item level",
"type": "string"
},
"itemLevelCallNumberPrefix": {
"description": "Prefix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberSuffix": {
"description": "Suffix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberTypeId": {
"description": "Call number type, refers to a call-number-type reference record",
"type": "string"
},
"effectiveCallNumberComponents": {
"type": "object",
"description": "Elements of a full call number generated from the item or holding",
"properties": {
"callNumber": {
"type": "string",
"description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"prefix": {
"type": "string",
"description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"suffix": {
"type": "string",
"description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"typeId": {
"type": "string",
"description": "Effective Call Number Type Id is the call number type id assigned to the item or associated holding.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"volume": {
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of Gerorge Bernard Shaw in three volumes)",
"type": "string"
},
"enumeration": {
"description": "Enumeration is the descriptive information for the numbering scheme of a serial, usually identified by level and a descriptive caption, e.g., level 0 = v. and level 1 = no. This means that each issue of the serial has a volume and an issue number that would appear (e.g. v.71:no.6-2)",
"type": "string"
},
"chronology": {
"description": "Chronology is the descriptive information for the dating scheme of a serial, usually identified by level, e.g., level 0 = year level 1 = month. This means that each issue of the serial has a month and a year on each issue (e.g. 1985:July-Dec.)",
"type": "string"
},
"yearCaption": {
"description": "In multipart monographs, a caption is characters used to label a level of chronology (e.g. 'year 1985')",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"description": "Item identifier number, e.g. imported from the union catalogue (read only)",
"type": "string"
},
"copyNumber": {
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; a copy of a multi-volume, (e.g. Copy 1, or C.7.)",
"type": "string"
},
"numberOfPieces": {
"description": "Number of pieces. Used when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set)",
"type": "string"
},
"descriptionOfPieces": {
"description": "Text which descripe the pieces",
"type": "string"
},
"numberOfMissingPieces": {
"description": "Number of missing pieces",
"type": "string"
},
"missingPieces": {
"description": "Text which descripes the missing pieces",
"type": "string"
},
"missingPiecesDate": {
"description": "Date when the piece(s) went missing",
"type": "string"
},
"itemDamagedStatusId": {
"description": "Item Damage status Id, refers to an Item damage Status ID reference record",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date when damage status was last changed",
"type": "string"
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"description": "notes",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Note for item record",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.ItemNotes",
"additionalProperties": false,
"properties": {
"itemNoteTypeId": {
"description": "Item note type, refers to a item-note-type reference record",
"type": "string"
},
"note": {
"description": "Text to display (e.g. action note, binding, use and reproduction)",
"type": "string"
},
"staffOnly": {
"description": "Records the fact that the record should only be displayed for staff",
"type": "boolean",
"default": false
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"noteType": {
"type": "string",
"description": "Type of circulation process that the note applies to",
"enum": [
"Check in",
"Check out"
]
},
"note": {
"type": "string",
"description": "Text to display"
},
"staffOnly": {
"type": "boolean",
"description": "Records the fact that the note should only be displayed for staff",
"default": false
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting.",
"readonly": true,
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note",
"readonly": true
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"readonly": true,
"properties": {
"lastName": {
"type": "string",
"description": "The user's last name",
"readonly": true
},
"firstName": {
"type": "string",
"description": "The user's first name",
"readonly": true
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting.",
"readonly": true
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the item state (e.g. Available, Checked out, In transit, Awaiting pickup, On order). Default value is set to: Available",
"type": "string",
"enum": [
"Aged to lost",
"Available",
"Awaiting delivery",
"Awaiting pickup",
"Checked out",
"Claimed returned",
"Declared lost",
"Lost and paid",
"Long missing",
"Missing",
"In process",
"In process (non-requestable)",
"In transit",
"Intellectual item",
"On order",
"Order closed",
"Paged",
"Restricted",
"Unavailable",
"Unknown",
"Withdrawn"
]
},
"date": {
"description": "Date of the current item state. E.g. date set when item state was changed by the Check out app",
"type": "string",
"readonly": true,
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"materialType": {
"description": "Material type define what type of thing the item is",
"type": "object",
"properties": {
"id": {
"description": "Material type Id, refers to a material type reference record",
"type": "string"
},
"name": {
"description": "Material type name (e.g. Audio book, Audio disc, Computer file, Pamphelet) ",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"isBoundWith": {
"description": "Indicates if this Item is a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"boundWithTitles": {
"description": "List of titles that are bound together within this Item",
"type": "array",
"items": {
"type": "object",
"description": "A title that is bound with other titles within this Item",
"properties": {
"briefHoldingsRecord": {
"type": "object",
"description": "Information about a holdings record that links a title to the bound-with Item",
"properties": {
"id": {
"description": "The UUID of the holdingsRecord",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the holdingsRecord",
"type": "string"
}
},
"additionalProperties": false
},
"briefInstance": {
"type": "object",
"description": "Information about an Instance / title that is bound with other title within this Item",
"properties": {
"id": {
"description": "The UUID of the Instance",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the Instance",
"type": "string"
},
"title": {
"description": "The title of the Instance",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"readonly": true
},
"permanentLoanType": {
"description": "Permanent loan type, is the default loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Permanent loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Permanent loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLoanType": {
"description": "Temporary loan type, is the temporary loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Temporary loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Temporary loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"permanentLocation": {
"description": "Permanent item location is the default location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Permanent location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Permanent location type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLocation": {
"description": "Temporary item location is the temporarily location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Temporary location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Temporary location name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"effectiveLocation": {
"type": "object",
"description": "The effective location is used by FOLIO and other integrated systems to know the current home location for the item (read only, derived from locations on HoldingsRecord and Item)",
"readonly": true,
"properties": {
"id": {
"type": "string",
"readonly": true
},
"name": {
"description": "Effective location name",
"type": "string",
"readonly": true
}
}
},
"electronicAccess": {
"description": "Whether an item is available electronically",
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "Link text is used for display in place of the URL"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id, refers to a Relationship type reference record. Relationship between the electronic resource at the location identified and the item described in the record as a whole. (E.g. values from MARC 21, tag field 856 2nd indicator, where the values are: No information provided, Resource, Version of resource, Related resource, No display constant generate"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "Statistical code Id, refers to a Statistical code reference record",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"tags": {
"description": "arbitrary tags associated with this item",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last checked in",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time",
"readonly": true
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"staffMemberId": {
"type": "string",
"description": "ID a staff member who scanned the item",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
},
"additionalProperties": false,
"required": [
"materialType",
"permanentLoanType",
"status"
]
}Example:
{
"id": "0b96a642-5e7f-452d-9cae-9cee66c9a892",
"title": "Uprooted",
"contributorNames": [{ "name": "Novik, Naomi" }],
"callNumber": "D11.J54 A3 2011",
"barcode": "645398607547",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLoanType": {
"id": "8e570d0d-931c-43d1-9ca1-221e693ea8d2",
"name": "Can Circulate"
},
"temporaryLoanType": {
"id": "74c25903-4019-4d8a-9360-5cb7761f44e5",
"name": "Course Reserve"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"inTransitDestinationServicePointId": "5b31ec8c-95a7-4b91-95cc-b551a74b91ca",
"tags" : {
"tagList" : [
"important"
]
}
}
HTTP status code 404
Item not found
Body
Media type: text/plain
Type: any
Example:
Item with such id not foundHTTP status code 422
Validation error
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server errorpost
post /inventory/items/{itemId}/mark-intellectual-item
URI Parameters
- itemId: required(string)
HTTP status code 200
Item has marked as intellectual item
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An item record",
"type": "object",
"properties": {
"id": {
"description": "Item id",
"type": "string"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"description": "ID of the holdings record the item is a member of",
"type": "string"
},
"order": {
"type": "integer",
"description": "Order of the item in the holdings record."
},
"formerIds": {
"type": "array",
"description": "Previous identifiers assigned to the item",
"items": {
"type": "string"
},
"uniqueItems": true
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"displaySummary": {
"description": "Display summary about the item",
"type": "string"
},
"title": {
"type": "string",
"description": "Resouce title (read only, inherited from associated instance record)",
"readonly": true
},
"contributorNames": {
"description": "A list of contributor names",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The contributor name",
"type": "string"
}
}
}
},
"additionalCallNumbers": {
"description": "Additional Call Numbers to track the history of identifiers assigned to an item.",
"type": "array",
"items": {
"type": "object",
"uniqueItems": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An additional call number",
"properties": {
"typeId": {
"type": "string",
"description": "unique ID for the type of call number, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"prefix": {
"type": "string",
"description": "Prefix of the call number."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item or holding, usually printed on a label attached to the item."
},
"suffix": {
"type": "string",
"description": "Suffix of the call number."
}
},
"required": [
"callNumber"
]
}
},
"callNumber": {
"type": "string",
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record)",
"readonly": true
},
"barcode": {
"description": "Text, with input likely validated by the barcode scanner",
"type": "string"
},
"effectiveShelvingOrder": {
"type": "string",
"description": "A system generated normalization of the call number that allows for call number sorting in reports and search results",
"readonly": true
},
"accessionNumber": {
"type": "string",
"description": "Accession number is also called inventar number. Accession number is a unique number assigned to an item in the order in which it is added to a library collection. Most libraries assign accession numbers in continous numerical sequece, but some use a code system to indicate type of material and/or year of accession in addition to order of accession"
},
"itemLevelCallNumber": {
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record). The item level call number, is the call number on item level",
"type": "string"
},
"itemLevelCallNumberPrefix": {
"description": "Prefix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberSuffix": {
"description": "Suffix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberTypeId": {
"description": "Call number type, refers to a call-number-type reference record",
"type": "string"
},
"effectiveCallNumberComponents": {
"type": "object",
"description": "Elements of a full call number generated from the item or holding",
"properties": {
"callNumber": {
"type": "string",
"description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"prefix": {
"type": "string",
"description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"suffix": {
"type": "string",
"description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"typeId": {
"type": "string",
"description": "Effective Call Number Type Id is the call number type id assigned to the item or associated holding.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"volume": {
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of Gerorge Bernard Shaw in three volumes)",
"type": "string"
},
"enumeration": {
"description": "Enumeration is the descriptive information for the numbering scheme of a serial, usually identified by level and a descriptive caption, e.g., level 0 = v. and level 1 = no. This means that each issue of the serial has a volume and an issue number that would appear (e.g. v.71:no.6-2)",
"type": "string"
},
"chronology": {
"description": "Chronology is the descriptive information for the dating scheme of a serial, usually identified by level, e.g., level 0 = year level 1 = month. This means that each issue of the serial has a month and a year on each issue (e.g. 1985:July-Dec.)",
"type": "string"
},
"yearCaption": {
"description": "In multipart monographs, a caption is characters used to label a level of chronology (e.g. 'year 1985')",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"description": "Item identifier number, e.g. imported from the union catalogue (read only)",
"type": "string"
},
"copyNumber": {
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; a copy of a multi-volume, (e.g. Copy 1, or C.7.)",
"type": "string"
},
"numberOfPieces": {
"description": "Number of pieces. Used when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set)",
"type": "string"
},
"descriptionOfPieces": {
"description": "Text which descripe the pieces",
"type": "string"
},
"numberOfMissingPieces": {
"description": "Number of missing pieces",
"type": "string"
},
"missingPieces": {
"description": "Text which descripes the missing pieces",
"type": "string"
},
"missingPiecesDate": {
"description": "Date when the piece(s) went missing",
"type": "string"
},
"itemDamagedStatusId": {
"description": "Item Damage status Id, refers to an Item damage Status ID reference record",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date when damage status was last changed",
"type": "string"
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"description": "notes",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Note for item record",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.ItemNotes",
"additionalProperties": false,
"properties": {
"itemNoteTypeId": {
"description": "Item note type, refers to a item-note-type reference record",
"type": "string"
},
"note": {
"description": "Text to display (e.g. action note, binding, use and reproduction)",
"type": "string"
},
"staffOnly": {
"description": "Records the fact that the record should only be displayed for staff",
"type": "boolean",
"default": false
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"noteType": {
"type": "string",
"description": "Type of circulation process that the note applies to",
"enum": [
"Check in",
"Check out"
]
},
"note": {
"type": "string",
"description": "Text to display"
},
"staffOnly": {
"type": "boolean",
"description": "Records the fact that the note should only be displayed for staff",
"default": false
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting.",
"readonly": true,
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note",
"readonly": true
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"readonly": true,
"properties": {
"lastName": {
"type": "string",
"description": "The user's last name",
"readonly": true
},
"firstName": {
"type": "string",
"description": "The user's first name",
"readonly": true
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting.",
"readonly": true
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the item state (e.g. Available, Checked out, In transit, Awaiting pickup, On order). Default value is set to: Available",
"type": "string",
"enum": [
"Aged to lost",
"Available",
"Awaiting delivery",
"Awaiting pickup",
"Checked out",
"Claimed returned",
"Declared lost",
"Lost and paid",
"Long missing",
"Missing",
"In process",
"In process (non-requestable)",
"In transit",
"Intellectual item",
"On order",
"Order closed",
"Paged",
"Restricted",
"Unavailable",
"Unknown",
"Withdrawn"
]
},
"date": {
"description": "Date of the current item state. E.g. date set when item state was changed by the Check out app",
"type": "string",
"readonly": true,
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"materialType": {
"description": "Material type define what type of thing the item is",
"type": "object",
"properties": {
"id": {
"description": "Material type Id, refers to a material type reference record",
"type": "string"
},
"name": {
"description": "Material type name (e.g. Audio book, Audio disc, Computer file, Pamphelet) ",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"isBoundWith": {
"description": "Indicates if this Item is a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"boundWithTitles": {
"description": "List of titles that are bound together within this Item",
"type": "array",
"items": {
"type": "object",
"description": "A title that is bound with other titles within this Item",
"properties": {
"briefHoldingsRecord": {
"type": "object",
"description": "Information about a holdings record that links a title to the bound-with Item",
"properties": {
"id": {
"description": "The UUID of the holdingsRecord",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the holdingsRecord",
"type": "string"
}
},
"additionalProperties": false
},
"briefInstance": {
"type": "object",
"description": "Information about an Instance / title that is bound with other title within this Item",
"properties": {
"id": {
"description": "The UUID of the Instance",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the Instance",
"type": "string"
},
"title": {
"description": "The title of the Instance",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"readonly": true
},
"permanentLoanType": {
"description": "Permanent loan type, is the default loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Permanent loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Permanent loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLoanType": {
"description": "Temporary loan type, is the temporary loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Temporary loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Temporary loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"permanentLocation": {
"description": "Permanent item location is the default location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Permanent location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Permanent location type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLocation": {
"description": "Temporary item location is the temporarily location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Temporary location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Temporary location name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"effectiveLocation": {
"type": "object",
"description": "The effective location is used by FOLIO and other integrated systems to know the current home location for the item (read only, derived from locations on HoldingsRecord and Item)",
"readonly": true,
"properties": {
"id": {
"type": "string",
"readonly": true
},
"name": {
"description": "Effective location name",
"type": "string",
"readonly": true
}
}
},
"electronicAccess": {
"description": "Whether an item is available electronically",
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "Link text is used for display in place of the URL"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id, refers to a Relationship type reference record. Relationship between the electronic resource at the location identified and the item described in the record as a whole. (E.g. values from MARC 21, tag field 856 2nd indicator, where the values are: No information provided, Resource, Version of resource, Related resource, No display constant generate"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "Statistical code Id, refers to a Statistical code reference record",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"tags": {
"description": "arbitrary tags associated with this item",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last checked in",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time",
"readonly": true
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"staffMemberId": {
"type": "string",
"description": "ID a staff member who scanned the item",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
},
"additionalProperties": false,
"required": [
"materialType",
"permanentLoanType",
"status"
]
}Example:
{
"id": "0b96a642-5e7f-452d-9cae-9cee66c9a892",
"title": "Uprooted",
"contributorNames": [{ "name": "Novik, Naomi" }],
"callNumber": "D11.J54 A3 2011",
"barcode": "645398607547",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLoanType": {
"id": "8e570d0d-931c-43d1-9ca1-221e693ea8d2",
"name": "Can Circulate"
},
"temporaryLoanType": {
"id": "74c25903-4019-4d8a-9360-5cb7761f44e5",
"name": "Course Reserve"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"inTransitDestinationServicePointId": "5b31ec8c-95a7-4b91-95cc-b551a74b91ca",
"tags" : {
"tagList" : [
"important"
]
}
}
HTTP status code 404
Item not found
Body
Media type: text/plain
Type: any
Example:
Item with such id not foundHTTP status code 422
Validation error
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server errorpost
post /inventory/items/{itemId}/mark-long-missing
URI Parameters
- itemId: required(string)
HTTP status code 200
Item has marked as long missing
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An item record",
"type": "object",
"properties": {
"id": {
"description": "Item id",
"type": "string"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"description": "ID of the holdings record the item is a member of",
"type": "string"
},
"order": {
"type": "integer",
"description": "Order of the item in the holdings record."
},
"formerIds": {
"type": "array",
"description": "Previous identifiers assigned to the item",
"items": {
"type": "string"
},
"uniqueItems": true
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"displaySummary": {
"description": "Display summary about the item",
"type": "string"
},
"title": {
"type": "string",
"description": "Resouce title (read only, inherited from associated instance record)",
"readonly": true
},
"contributorNames": {
"description": "A list of contributor names",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The contributor name",
"type": "string"
}
}
}
},
"additionalCallNumbers": {
"description": "Additional Call Numbers to track the history of identifiers assigned to an item.",
"type": "array",
"items": {
"type": "object",
"uniqueItems": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An additional call number",
"properties": {
"typeId": {
"type": "string",
"description": "unique ID for the type of call number, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"prefix": {
"type": "string",
"description": "Prefix of the call number."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item or holding, usually printed on a label attached to the item."
},
"suffix": {
"type": "string",
"description": "Suffix of the call number."
}
},
"required": [
"callNumber"
]
}
},
"callNumber": {
"type": "string",
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record)",
"readonly": true
},
"barcode": {
"description": "Text, with input likely validated by the barcode scanner",
"type": "string"
},
"effectiveShelvingOrder": {
"type": "string",
"description": "A system generated normalization of the call number that allows for call number sorting in reports and search results",
"readonly": true
},
"accessionNumber": {
"type": "string",
"description": "Accession number is also called inventar number. Accession number is a unique number assigned to an item in the order in which it is added to a library collection. Most libraries assign accession numbers in continous numerical sequece, but some use a code system to indicate type of material and/or year of accession in addition to order of accession"
},
"itemLevelCallNumber": {
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record). The item level call number, is the call number on item level",
"type": "string"
},
"itemLevelCallNumberPrefix": {
"description": "Prefix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberSuffix": {
"description": "Suffix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberTypeId": {
"description": "Call number type, refers to a call-number-type reference record",
"type": "string"
},
"effectiveCallNumberComponents": {
"type": "object",
"description": "Elements of a full call number generated from the item or holding",
"properties": {
"callNumber": {
"type": "string",
"description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"prefix": {
"type": "string",
"description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"suffix": {
"type": "string",
"description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"typeId": {
"type": "string",
"description": "Effective Call Number Type Id is the call number type id assigned to the item or associated holding.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"volume": {
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of Gerorge Bernard Shaw in three volumes)",
"type": "string"
},
"enumeration": {
"description": "Enumeration is the descriptive information for the numbering scheme of a serial, usually identified by level and a descriptive caption, e.g., level 0 = v. and level 1 = no. This means that each issue of the serial has a volume and an issue number that would appear (e.g. v.71:no.6-2)",
"type": "string"
},
"chronology": {
"description": "Chronology is the descriptive information for the dating scheme of a serial, usually identified by level, e.g., level 0 = year level 1 = month. This means that each issue of the serial has a month and a year on each issue (e.g. 1985:July-Dec.)",
"type": "string"
},
"yearCaption": {
"description": "In multipart monographs, a caption is characters used to label a level of chronology (e.g. 'year 1985')",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"description": "Item identifier number, e.g. imported from the union catalogue (read only)",
"type": "string"
},
"copyNumber": {
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; a copy of a multi-volume, (e.g. Copy 1, or C.7.)",
"type": "string"
},
"numberOfPieces": {
"description": "Number of pieces. Used when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set)",
"type": "string"
},
"descriptionOfPieces": {
"description": "Text which descripe the pieces",
"type": "string"
},
"numberOfMissingPieces": {
"description": "Number of missing pieces",
"type": "string"
},
"missingPieces": {
"description": "Text which descripes the missing pieces",
"type": "string"
},
"missingPiecesDate": {
"description": "Date when the piece(s) went missing",
"type": "string"
},
"itemDamagedStatusId": {
"description": "Item Damage status Id, refers to an Item damage Status ID reference record",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date when damage status was last changed",
"type": "string"
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"description": "notes",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Note for item record",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.ItemNotes",
"additionalProperties": false,
"properties": {
"itemNoteTypeId": {
"description": "Item note type, refers to a item-note-type reference record",
"type": "string"
},
"note": {
"description": "Text to display (e.g. action note, binding, use and reproduction)",
"type": "string"
},
"staffOnly": {
"description": "Records the fact that the record should only be displayed for staff",
"type": "boolean",
"default": false
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"noteType": {
"type": "string",
"description": "Type of circulation process that the note applies to",
"enum": [
"Check in",
"Check out"
]
},
"note": {
"type": "string",
"description": "Text to display"
},
"staffOnly": {
"type": "boolean",
"description": "Records the fact that the note should only be displayed for staff",
"default": false
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting.",
"readonly": true,
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note",
"readonly": true
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"readonly": true,
"properties": {
"lastName": {
"type": "string",
"description": "The user's last name",
"readonly": true
},
"firstName": {
"type": "string",
"description": "The user's first name",
"readonly": true
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting.",
"readonly": true
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the item state (e.g. Available, Checked out, In transit, Awaiting pickup, On order). Default value is set to: Available",
"type": "string",
"enum": [
"Aged to lost",
"Available",
"Awaiting delivery",
"Awaiting pickup",
"Checked out",
"Claimed returned",
"Declared lost",
"Lost and paid",
"Long missing",
"Missing",
"In process",
"In process (non-requestable)",
"In transit",
"Intellectual item",
"On order",
"Order closed",
"Paged",
"Restricted",
"Unavailable",
"Unknown",
"Withdrawn"
]
},
"date": {
"description": "Date of the current item state. E.g. date set when item state was changed by the Check out app",
"type": "string",
"readonly": true,
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"materialType": {
"description": "Material type define what type of thing the item is",
"type": "object",
"properties": {
"id": {
"description": "Material type Id, refers to a material type reference record",
"type": "string"
},
"name": {
"description": "Material type name (e.g. Audio book, Audio disc, Computer file, Pamphelet) ",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"isBoundWith": {
"description": "Indicates if this Item is a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"boundWithTitles": {
"description": "List of titles that are bound together within this Item",
"type": "array",
"items": {
"type": "object",
"description": "A title that is bound with other titles within this Item",
"properties": {
"briefHoldingsRecord": {
"type": "object",
"description": "Information about a holdings record that links a title to the bound-with Item",
"properties": {
"id": {
"description": "The UUID of the holdingsRecord",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the holdingsRecord",
"type": "string"
}
},
"additionalProperties": false
},
"briefInstance": {
"type": "object",
"description": "Information about an Instance / title that is bound with other title within this Item",
"properties": {
"id": {
"description": "The UUID of the Instance",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the Instance",
"type": "string"
},
"title": {
"description": "The title of the Instance",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"readonly": true
},
"permanentLoanType": {
"description": "Permanent loan type, is the default loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Permanent loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Permanent loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLoanType": {
"description": "Temporary loan type, is the temporary loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Temporary loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Temporary loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"permanentLocation": {
"description": "Permanent item location is the default location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Permanent location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Permanent location type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLocation": {
"description": "Temporary item location is the temporarily location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Temporary location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Temporary location name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"effectiveLocation": {
"type": "object",
"description": "The effective location is used by FOLIO and other integrated systems to know the current home location for the item (read only, derived from locations on HoldingsRecord and Item)",
"readonly": true,
"properties": {
"id": {
"type": "string",
"readonly": true
},
"name": {
"description": "Effective location name",
"type": "string",
"readonly": true
}
}
},
"electronicAccess": {
"description": "Whether an item is available electronically",
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "Link text is used for display in place of the URL"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id, refers to a Relationship type reference record. Relationship between the electronic resource at the location identified and the item described in the record as a whole. (E.g. values from MARC 21, tag field 856 2nd indicator, where the values are: No information provided, Resource, Version of resource, Related resource, No display constant generate"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "Statistical code Id, refers to a Statistical code reference record",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"tags": {
"description": "arbitrary tags associated with this item",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last checked in",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time",
"readonly": true
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"staffMemberId": {
"type": "string",
"description": "ID a staff member who scanned the item",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
},
"additionalProperties": false,
"required": [
"materialType",
"permanentLoanType",
"status"
]
}Example:
{
"id": "0b96a642-5e7f-452d-9cae-9cee66c9a892",
"title": "Uprooted",
"contributorNames": [{ "name": "Novik, Naomi" }],
"callNumber": "D11.J54 A3 2011",
"barcode": "645398607547",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLoanType": {
"id": "8e570d0d-931c-43d1-9ca1-221e693ea8d2",
"name": "Can Circulate"
},
"temporaryLoanType": {
"id": "74c25903-4019-4d8a-9360-5cb7761f44e5",
"name": "Course Reserve"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"inTransitDestinationServicePointId": "5b31ec8c-95a7-4b91-95cc-b551a74b91ca",
"tags" : {
"tagList" : [
"important"
]
}
}
HTTP status code 404
Item not found
Body
Media type: text/plain
Type: any
Example:
Item with such id not foundHTTP status code 422
Validation error
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server errorpost
post /inventory/items/{itemId}/mark-missing
URI Parameters
- itemId: required(string)
HTTP status code 201
Item has marked as missing
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An item record",
"type": "object",
"properties": {
"id": {
"description": "Item id",
"type": "string"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"description": "ID of the holdings record the item is a member of",
"type": "string"
},
"order": {
"type": "integer",
"description": "Order of the item in the holdings record."
},
"formerIds": {
"type": "array",
"description": "Previous identifiers assigned to the item",
"items": {
"type": "string"
},
"uniqueItems": true
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"displaySummary": {
"description": "Display summary about the item",
"type": "string"
},
"title": {
"type": "string",
"description": "Resouce title (read only, inherited from associated instance record)",
"readonly": true
},
"contributorNames": {
"description": "A list of contributor names",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The contributor name",
"type": "string"
}
}
}
},
"additionalCallNumbers": {
"description": "Additional Call Numbers to track the history of identifiers assigned to an item.",
"type": "array",
"items": {
"type": "object",
"uniqueItems": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An additional call number",
"properties": {
"typeId": {
"type": "string",
"description": "unique ID for the type of call number, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"prefix": {
"type": "string",
"description": "Prefix of the call number."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item or holding, usually printed on a label attached to the item."
},
"suffix": {
"type": "string",
"description": "Suffix of the call number."
}
},
"required": [
"callNumber"
]
}
},
"callNumber": {
"type": "string",
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record)",
"readonly": true
},
"barcode": {
"description": "Text, with input likely validated by the barcode scanner",
"type": "string"
},
"effectiveShelvingOrder": {
"type": "string",
"description": "A system generated normalization of the call number that allows for call number sorting in reports and search results",
"readonly": true
},
"accessionNumber": {
"type": "string",
"description": "Accession number is also called inventar number. Accession number is a unique number assigned to an item in the order in which it is added to a library collection. Most libraries assign accession numbers in continous numerical sequece, but some use a code system to indicate type of material and/or year of accession in addition to order of accession"
},
"itemLevelCallNumber": {
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record). The item level call number, is the call number on item level",
"type": "string"
},
"itemLevelCallNumberPrefix": {
"description": "Prefix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberSuffix": {
"description": "Suffix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberTypeId": {
"description": "Call number type, refers to a call-number-type reference record",
"type": "string"
},
"effectiveCallNumberComponents": {
"type": "object",
"description": "Elements of a full call number generated from the item or holding",
"properties": {
"callNumber": {
"type": "string",
"description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"prefix": {
"type": "string",
"description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"suffix": {
"type": "string",
"description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"typeId": {
"type": "string",
"description": "Effective Call Number Type Id is the call number type id assigned to the item or associated holding.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"volume": {
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of Gerorge Bernard Shaw in three volumes)",
"type": "string"
},
"enumeration": {
"description": "Enumeration is the descriptive information for the numbering scheme of a serial, usually identified by level and a descriptive caption, e.g., level 0 = v. and level 1 = no. This means that each issue of the serial has a volume and an issue number that would appear (e.g. v.71:no.6-2)",
"type": "string"
},
"chronology": {
"description": "Chronology is the descriptive information for the dating scheme of a serial, usually identified by level, e.g., level 0 = year level 1 = month. This means that each issue of the serial has a month and a year on each issue (e.g. 1985:July-Dec.)",
"type": "string"
},
"yearCaption": {
"description": "In multipart monographs, a caption is characters used to label a level of chronology (e.g. 'year 1985')",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"description": "Item identifier number, e.g. imported from the union catalogue (read only)",
"type": "string"
},
"copyNumber": {
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; a copy of a multi-volume, (e.g. Copy 1, or C.7.)",
"type": "string"
},
"numberOfPieces": {
"description": "Number of pieces. Used when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set)",
"type": "string"
},
"descriptionOfPieces": {
"description": "Text which descripe the pieces",
"type": "string"
},
"numberOfMissingPieces": {
"description": "Number of missing pieces",
"type": "string"
},
"missingPieces": {
"description": "Text which descripes the missing pieces",
"type": "string"
},
"missingPiecesDate": {
"description": "Date when the piece(s) went missing",
"type": "string"
},
"itemDamagedStatusId": {
"description": "Item Damage status Id, refers to an Item damage Status ID reference record",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date when damage status was last changed",
"type": "string"
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"description": "notes",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Note for item record",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.ItemNotes",
"additionalProperties": false,
"properties": {
"itemNoteTypeId": {
"description": "Item note type, refers to a item-note-type reference record",
"type": "string"
},
"note": {
"description": "Text to display (e.g. action note, binding, use and reproduction)",
"type": "string"
},
"staffOnly": {
"description": "Records the fact that the record should only be displayed for staff",
"type": "boolean",
"default": false
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"noteType": {
"type": "string",
"description": "Type of circulation process that the note applies to",
"enum": [
"Check in",
"Check out"
]
},
"note": {
"type": "string",
"description": "Text to display"
},
"staffOnly": {
"type": "boolean",
"description": "Records the fact that the note should only be displayed for staff",
"default": false
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting.",
"readonly": true,
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note",
"readonly": true
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"readonly": true,
"properties": {
"lastName": {
"type": "string",
"description": "The user's last name",
"readonly": true
},
"firstName": {
"type": "string",
"description": "The user's first name",
"readonly": true
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting.",
"readonly": true
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the item state (e.g. Available, Checked out, In transit, Awaiting pickup, On order). Default value is set to: Available",
"type": "string",
"enum": [
"Aged to lost",
"Available",
"Awaiting delivery",
"Awaiting pickup",
"Checked out",
"Claimed returned",
"Declared lost",
"Lost and paid",
"Long missing",
"Missing",
"In process",
"In process (non-requestable)",
"In transit",
"Intellectual item",
"On order",
"Order closed",
"Paged",
"Restricted",
"Unavailable",
"Unknown",
"Withdrawn"
]
},
"date": {
"description": "Date of the current item state. E.g. date set when item state was changed by the Check out app",
"type": "string",
"readonly": true,
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"materialType": {
"description": "Material type define what type of thing the item is",
"type": "object",
"properties": {
"id": {
"description": "Material type Id, refers to a material type reference record",
"type": "string"
},
"name": {
"description": "Material type name (e.g. Audio book, Audio disc, Computer file, Pamphelet) ",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"isBoundWith": {
"description": "Indicates if this Item is a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"boundWithTitles": {
"description": "List of titles that are bound together within this Item",
"type": "array",
"items": {
"type": "object",
"description": "A title that is bound with other titles within this Item",
"properties": {
"briefHoldingsRecord": {
"type": "object",
"description": "Information about a holdings record that links a title to the bound-with Item",
"properties": {
"id": {
"description": "The UUID of the holdingsRecord",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the holdingsRecord",
"type": "string"
}
},
"additionalProperties": false
},
"briefInstance": {
"type": "object",
"description": "Information about an Instance / title that is bound with other title within this Item",
"properties": {
"id": {
"description": "The UUID of the Instance",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the Instance",
"type": "string"
},
"title": {
"description": "The title of the Instance",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"readonly": true
},
"permanentLoanType": {
"description": "Permanent loan type, is the default loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Permanent loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Permanent loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLoanType": {
"description": "Temporary loan type, is the temporary loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Temporary loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Temporary loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"permanentLocation": {
"description": "Permanent item location is the default location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Permanent location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Permanent location type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLocation": {
"description": "Temporary item location is the temporarily location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Temporary location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Temporary location name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"effectiveLocation": {
"type": "object",
"description": "The effective location is used by FOLIO and other integrated systems to know the current home location for the item (read only, derived from locations on HoldingsRecord and Item)",
"readonly": true,
"properties": {
"id": {
"type": "string",
"readonly": true
},
"name": {
"description": "Effective location name",
"type": "string",
"readonly": true
}
}
},
"electronicAccess": {
"description": "Whether an item is available electronically",
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "Link text is used for display in place of the URL"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id, refers to a Relationship type reference record. Relationship between the electronic resource at the location identified and the item described in the record as a whole. (E.g. values from MARC 21, tag field 856 2nd indicator, where the values are: No information provided, Resource, Version of resource, Related resource, No display constant generate"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "Statistical code Id, refers to a Statistical code reference record",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"tags": {
"description": "arbitrary tags associated with this item",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last checked in",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time",
"readonly": true
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"staffMemberId": {
"type": "string",
"description": "ID a staff member who scanned the item",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
},
"additionalProperties": false,
"required": [
"materialType",
"permanentLoanType",
"status"
]
}Example:
{
"id": "0b96a642-5e7f-452d-9cae-9cee66c9a892",
"title": "Uprooted",
"contributorNames": [{ "name": "Novik, Naomi" }],
"callNumber": "D11.J54 A3 2011",
"barcode": "645398607547",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLoanType": {
"id": "8e570d0d-931c-43d1-9ca1-221e693ea8d2",
"name": "Can Circulate"
},
"temporaryLoanType": {
"id": "74c25903-4019-4d8a-9360-5cb7761f44e5",
"name": "Course Reserve"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"inTransitDestinationServicePointId": "5b31ec8c-95a7-4b91-95cc-b551a74b91ca",
"tags" : {
"tagList" : [
"important"
]
}
}
HTTP status code 404
Item not found
Body
Media type: text/plain
Type: any
Example:
Item with such id not foundHTTP status code 422
Validation error
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server errorpost
post /inventory/items/{itemId}/mark-restricted
URI Parameters
- itemId: required(string)
HTTP status code 200
Item has marked as restricted
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An item record",
"type": "object",
"properties": {
"id": {
"description": "Item id",
"type": "string"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"description": "ID of the holdings record the item is a member of",
"type": "string"
},
"order": {
"type": "integer",
"description": "Order of the item in the holdings record."
},
"formerIds": {
"type": "array",
"description": "Previous identifiers assigned to the item",
"items": {
"type": "string"
},
"uniqueItems": true
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"displaySummary": {
"description": "Display summary about the item",
"type": "string"
},
"title": {
"type": "string",
"description": "Resouce title (read only, inherited from associated instance record)",
"readonly": true
},
"contributorNames": {
"description": "A list of contributor names",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The contributor name",
"type": "string"
}
}
}
},
"additionalCallNumbers": {
"description": "Additional Call Numbers to track the history of identifiers assigned to an item.",
"type": "array",
"items": {
"type": "object",
"uniqueItems": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An additional call number",
"properties": {
"typeId": {
"type": "string",
"description": "unique ID for the type of call number, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"prefix": {
"type": "string",
"description": "Prefix of the call number."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item or holding, usually printed on a label attached to the item."
},
"suffix": {
"type": "string",
"description": "Suffix of the call number."
}
},
"required": [
"callNumber"
]
}
},
"callNumber": {
"type": "string",
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record)",
"readonly": true
},
"barcode": {
"description": "Text, with input likely validated by the barcode scanner",
"type": "string"
},
"effectiveShelvingOrder": {
"type": "string",
"description": "A system generated normalization of the call number that allows for call number sorting in reports and search results",
"readonly": true
},
"accessionNumber": {
"type": "string",
"description": "Accession number is also called inventar number. Accession number is a unique number assigned to an item in the order in which it is added to a library collection. Most libraries assign accession numbers in continous numerical sequece, but some use a code system to indicate type of material and/or year of accession in addition to order of accession"
},
"itemLevelCallNumber": {
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record). The item level call number, is the call number on item level",
"type": "string"
},
"itemLevelCallNumberPrefix": {
"description": "Prefix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberSuffix": {
"description": "Suffix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberTypeId": {
"description": "Call number type, refers to a call-number-type reference record",
"type": "string"
},
"effectiveCallNumberComponents": {
"type": "object",
"description": "Elements of a full call number generated from the item or holding",
"properties": {
"callNumber": {
"type": "string",
"description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"prefix": {
"type": "string",
"description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"suffix": {
"type": "string",
"description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"typeId": {
"type": "string",
"description": "Effective Call Number Type Id is the call number type id assigned to the item or associated holding.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"volume": {
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of Gerorge Bernard Shaw in three volumes)",
"type": "string"
},
"enumeration": {
"description": "Enumeration is the descriptive information for the numbering scheme of a serial, usually identified by level and a descriptive caption, e.g., level 0 = v. and level 1 = no. This means that each issue of the serial has a volume and an issue number that would appear (e.g. v.71:no.6-2)",
"type": "string"
},
"chronology": {
"description": "Chronology is the descriptive information for the dating scheme of a serial, usually identified by level, e.g., level 0 = year level 1 = month. This means that each issue of the serial has a month and a year on each issue (e.g. 1985:July-Dec.)",
"type": "string"
},
"yearCaption": {
"description": "In multipart monographs, a caption is characters used to label a level of chronology (e.g. 'year 1985')",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"description": "Item identifier number, e.g. imported from the union catalogue (read only)",
"type": "string"
},
"copyNumber": {
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; a copy of a multi-volume, (e.g. Copy 1, or C.7.)",
"type": "string"
},
"numberOfPieces": {
"description": "Number of pieces. Used when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set)",
"type": "string"
},
"descriptionOfPieces": {
"description": "Text which descripe the pieces",
"type": "string"
},
"numberOfMissingPieces": {
"description": "Number of missing pieces",
"type": "string"
},
"missingPieces": {
"description": "Text which descripes the missing pieces",
"type": "string"
},
"missingPiecesDate": {
"description": "Date when the piece(s) went missing",
"type": "string"
},
"itemDamagedStatusId": {
"description": "Item Damage status Id, refers to an Item damage Status ID reference record",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date when damage status was last changed",
"type": "string"
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"description": "notes",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Note for item record",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.ItemNotes",
"additionalProperties": false,
"properties": {
"itemNoteTypeId": {
"description": "Item note type, refers to a item-note-type reference record",
"type": "string"
},
"note": {
"description": "Text to display (e.g. action note, binding, use and reproduction)",
"type": "string"
},
"staffOnly": {
"description": "Records the fact that the record should only be displayed for staff",
"type": "boolean",
"default": false
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"noteType": {
"type": "string",
"description": "Type of circulation process that the note applies to",
"enum": [
"Check in",
"Check out"
]
},
"note": {
"type": "string",
"description": "Text to display"
},
"staffOnly": {
"type": "boolean",
"description": "Records the fact that the note should only be displayed for staff",
"default": false
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting.",
"readonly": true,
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note",
"readonly": true
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"readonly": true,
"properties": {
"lastName": {
"type": "string",
"description": "The user's last name",
"readonly": true
},
"firstName": {
"type": "string",
"description": "The user's first name",
"readonly": true
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting.",
"readonly": true
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the item state (e.g. Available, Checked out, In transit, Awaiting pickup, On order). Default value is set to: Available",
"type": "string",
"enum": [
"Aged to lost",
"Available",
"Awaiting delivery",
"Awaiting pickup",
"Checked out",
"Claimed returned",
"Declared lost",
"Lost and paid",
"Long missing",
"Missing",
"In process",
"In process (non-requestable)",
"In transit",
"Intellectual item",
"On order",
"Order closed",
"Paged",
"Restricted",
"Unavailable",
"Unknown",
"Withdrawn"
]
},
"date": {
"description": "Date of the current item state. E.g. date set when item state was changed by the Check out app",
"type": "string",
"readonly": true,
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"materialType": {
"description": "Material type define what type of thing the item is",
"type": "object",
"properties": {
"id": {
"description": "Material type Id, refers to a material type reference record",
"type": "string"
},
"name": {
"description": "Material type name (e.g. Audio book, Audio disc, Computer file, Pamphelet) ",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"isBoundWith": {
"description": "Indicates if this Item is a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"boundWithTitles": {
"description": "List of titles that are bound together within this Item",
"type": "array",
"items": {
"type": "object",
"description": "A title that is bound with other titles within this Item",
"properties": {
"briefHoldingsRecord": {
"type": "object",
"description": "Information about a holdings record that links a title to the bound-with Item",
"properties": {
"id": {
"description": "The UUID of the holdingsRecord",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the holdingsRecord",
"type": "string"
}
},
"additionalProperties": false
},
"briefInstance": {
"type": "object",
"description": "Information about an Instance / title that is bound with other title within this Item",
"properties": {
"id": {
"description": "The UUID of the Instance",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the Instance",
"type": "string"
},
"title": {
"description": "The title of the Instance",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"readonly": true
},
"permanentLoanType": {
"description": "Permanent loan type, is the default loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Permanent loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Permanent loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLoanType": {
"description": "Temporary loan type, is the temporary loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Temporary loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Temporary loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"permanentLocation": {
"description": "Permanent item location is the default location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Permanent location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Permanent location type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLocation": {
"description": "Temporary item location is the temporarily location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Temporary location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Temporary location name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"effectiveLocation": {
"type": "object",
"description": "The effective location is used by FOLIO and other integrated systems to know the current home location for the item (read only, derived from locations on HoldingsRecord and Item)",
"readonly": true,
"properties": {
"id": {
"type": "string",
"readonly": true
},
"name": {
"description": "Effective location name",
"type": "string",
"readonly": true
}
}
},
"electronicAccess": {
"description": "Whether an item is available electronically",
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "Link text is used for display in place of the URL"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id, refers to a Relationship type reference record. Relationship between the electronic resource at the location identified and the item described in the record as a whole. (E.g. values from MARC 21, tag field 856 2nd indicator, where the values are: No information provided, Resource, Version of resource, Related resource, No display constant generate"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "Statistical code Id, refers to a Statistical code reference record",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"tags": {
"description": "arbitrary tags associated with this item",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last checked in",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time",
"readonly": true
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"staffMemberId": {
"type": "string",
"description": "ID a staff member who scanned the item",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
},
"additionalProperties": false,
"required": [
"materialType",
"permanentLoanType",
"status"
]
}Example:
{
"id": "0b96a642-5e7f-452d-9cae-9cee66c9a892",
"title": "Uprooted",
"contributorNames": [{ "name": "Novik, Naomi" }],
"callNumber": "D11.J54 A3 2011",
"barcode": "645398607547",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLoanType": {
"id": "8e570d0d-931c-43d1-9ca1-221e693ea8d2",
"name": "Can Circulate"
},
"temporaryLoanType": {
"id": "74c25903-4019-4d8a-9360-5cb7761f44e5",
"name": "Course Reserve"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"inTransitDestinationServicePointId": "5b31ec8c-95a7-4b91-95cc-b551a74b91ca",
"tags" : {
"tagList" : [
"important"
]
}
}
HTTP status code 404
Item not found
Body
Media type: text/plain
Type: any
Example:
Item with such id not foundHTTP status code 422
Validation error
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server errorpost
post /inventory/items/{itemId}/mark-unavailable
URI Parameters
- itemId: required(string)
HTTP status code 200
Item has marked as unavailable
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An item record",
"type": "object",
"properties": {
"id": {
"description": "Item id",
"type": "string"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"description": "ID of the holdings record the item is a member of",
"type": "string"
},
"order": {
"type": "integer",
"description": "Order of the item in the holdings record."
},
"formerIds": {
"type": "array",
"description": "Previous identifiers assigned to the item",
"items": {
"type": "string"
},
"uniqueItems": true
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"displaySummary": {
"description": "Display summary about the item",
"type": "string"
},
"title": {
"type": "string",
"description": "Resouce title (read only, inherited from associated instance record)",
"readonly": true
},
"contributorNames": {
"description": "A list of contributor names",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The contributor name",
"type": "string"
}
}
}
},
"additionalCallNumbers": {
"description": "Additional Call Numbers to track the history of identifiers assigned to an item.",
"type": "array",
"items": {
"type": "object",
"uniqueItems": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An additional call number",
"properties": {
"typeId": {
"type": "string",
"description": "unique ID for the type of call number, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"prefix": {
"type": "string",
"description": "Prefix of the call number."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item or holding, usually printed on a label attached to the item."
},
"suffix": {
"type": "string",
"description": "Suffix of the call number."
}
},
"required": [
"callNumber"
]
}
},
"callNumber": {
"type": "string",
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record)",
"readonly": true
},
"barcode": {
"description": "Text, with input likely validated by the barcode scanner",
"type": "string"
},
"effectiveShelvingOrder": {
"type": "string",
"description": "A system generated normalization of the call number that allows for call number sorting in reports and search results",
"readonly": true
},
"accessionNumber": {
"type": "string",
"description": "Accession number is also called inventar number. Accession number is a unique number assigned to an item in the order in which it is added to a library collection. Most libraries assign accession numbers in continous numerical sequece, but some use a code system to indicate type of material and/or year of accession in addition to order of accession"
},
"itemLevelCallNumber": {
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record). The item level call number, is the call number on item level",
"type": "string"
},
"itemLevelCallNumberPrefix": {
"description": "Prefix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberSuffix": {
"description": "Suffix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberTypeId": {
"description": "Call number type, refers to a call-number-type reference record",
"type": "string"
},
"effectiveCallNumberComponents": {
"type": "object",
"description": "Elements of a full call number generated from the item or holding",
"properties": {
"callNumber": {
"type": "string",
"description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"prefix": {
"type": "string",
"description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"suffix": {
"type": "string",
"description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"typeId": {
"type": "string",
"description": "Effective Call Number Type Id is the call number type id assigned to the item or associated holding.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"volume": {
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of Gerorge Bernard Shaw in three volumes)",
"type": "string"
},
"enumeration": {
"description": "Enumeration is the descriptive information for the numbering scheme of a serial, usually identified by level and a descriptive caption, e.g., level 0 = v. and level 1 = no. This means that each issue of the serial has a volume and an issue number that would appear (e.g. v.71:no.6-2)",
"type": "string"
},
"chronology": {
"description": "Chronology is the descriptive information for the dating scheme of a serial, usually identified by level, e.g., level 0 = year level 1 = month. This means that each issue of the serial has a month and a year on each issue (e.g. 1985:July-Dec.)",
"type": "string"
},
"yearCaption": {
"description": "In multipart monographs, a caption is characters used to label a level of chronology (e.g. 'year 1985')",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"description": "Item identifier number, e.g. imported from the union catalogue (read only)",
"type": "string"
},
"copyNumber": {
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; a copy of a multi-volume, (e.g. Copy 1, or C.7.)",
"type": "string"
},
"numberOfPieces": {
"description": "Number of pieces. Used when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set)",
"type": "string"
},
"descriptionOfPieces": {
"description": "Text which descripe the pieces",
"type": "string"
},
"numberOfMissingPieces": {
"description": "Number of missing pieces",
"type": "string"
},
"missingPieces": {
"description": "Text which descripes the missing pieces",
"type": "string"
},
"missingPiecesDate": {
"description": "Date when the piece(s) went missing",
"type": "string"
},
"itemDamagedStatusId": {
"description": "Item Damage status Id, refers to an Item damage Status ID reference record",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date when damage status was last changed",
"type": "string"
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"description": "notes",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Note for item record",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.ItemNotes",
"additionalProperties": false,
"properties": {
"itemNoteTypeId": {
"description": "Item note type, refers to a item-note-type reference record",
"type": "string"
},
"note": {
"description": "Text to display (e.g. action note, binding, use and reproduction)",
"type": "string"
},
"staffOnly": {
"description": "Records the fact that the record should only be displayed for staff",
"type": "boolean",
"default": false
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"noteType": {
"type": "string",
"description": "Type of circulation process that the note applies to",
"enum": [
"Check in",
"Check out"
]
},
"note": {
"type": "string",
"description": "Text to display"
},
"staffOnly": {
"type": "boolean",
"description": "Records the fact that the note should only be displayed for staff",
"default": false
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting.",
"readonly": true,
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note",
"readonly": true
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"readonly": true,
"properties": {
"lastName": {
"type": "string",
"description": "The user's last name",
"readonly": true
},
"firstName": {
"type": "string",
"description": "The user's first name",
"readonly": true
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting.",
"readonly": true
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the item state (e.g. Available, Checked out, In transit, Awaiting pickup, On order). Default value is set to: Available",
"type": "string",
"enum": [
"Aged to lost",
"Available",
"Awaiting delivery",
"Awaiting pickup",
"Checked out",
"Claimed returned",
"Declared lost",
"Lost and paid",
"Long missing",
"Missing",
"In process",
"In process (non-requestable)",
"In transit",
"Intellectual item",
"On order",
"Order closed",
"Paged",
"Restricted",
"Unavailable",
"Unknown",
"Withdrawn"
]
},
"date": {
"description": "Date of the current item state. E.g. date set when item state was changed by the Check out app",
"type": "string",
"readonly": true,
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"materialType": {
"description": "Material type define what type of thing the item is",
"type": "object",
"properties": {
"id": {
"description": "Material type Id, refers to a material type reference record",
"type": "string"
},
"name": {
"description": "Material type name (e.g. Audio book, Audio disc, Computer file, Pamphelet) ",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"isBoundWith": {
"description": "Indicates if this Item is a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"boundWithTitles": {
"description": "List of titles that are bound together within this Item",
"type": "array",
"items": {
"type": "object",
"description": "A title that is bound with other titles within this Item",
"properties": {
"briefHoldingsRecord": {
"type": "object",
"description": "Information about a holdings record that links a title to the bound-with Item",
"properties": {
"id": {
"description": "The UUID of the holdingsRecord",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the holdingsRecord",
"type": "string"
}
},
"additionalProperties": false
},
"briefInstance": {
"type": "object",
"description": "Information about an Instance / title that is bound with other title within this Item",
"properties": {
"id": {
"description": "The UUID of the Instance",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the Instance",
"type": "string"
},
"title": {
"description": "The title of the Instance",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"readonly": true
},
"permanentLoanType": {
"description": "Permanent loan type, is the default loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Permanent loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Permanent loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLoanType": {
"description": "Temporary loan type, is the temporary loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Temporary loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Temporary loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"permanentLocation": {
"description": "Permanent item location is the default location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Permanent location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Permanent location type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLocation": {
"description": "Temporary item location is the temporarily location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Temporary location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Temporary location name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"effectiveLocation": {
"type": "object",
"description": "The effective location is used by FOLIO and other integrated systems to know the current home location for the item (read only, derived from locations on HoldingsRecord and Item)",
"readonly": true,
"properties": {
"id": {
"type": "string",
"readonly": true
},
"name": {
"description": "Effective location name",
"type": "string",
"readonly": true
}
}
},
"electronicAccess": {
"description": "Whether an item is available electronically",
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "Link text is used for display in place of the URL"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id, refers to a Relationship type reference record. Relationship between the electronic resource at the location identified and the item described in the record as a whole. (E.g. values from MARC 21, tag field 856 2nd indicator, where the values are: No information provided, Resource, Version of resource, Related resource, No display constant generate"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "Statistical code Id, refers to a Statistical code reference record",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"tags": {
"description": "arbitrary tags associated with this item",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last checked in",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time",
"readonly": true
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"staffMemberId": {
"type": "string",
"description": "ID a staff member who scanned the item",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
},
"additionalProperties": false,
"required": [
"materialType",
"permanentLoanType",
"status"
]
}Example:
{
"id": "0b96a642-5e7f-452d-9cae-9cee66c9a892",
"title": "Uprooted",
"contributorNames": [{ "name": "Novik, Naomi" }],
"callNumber": "D11.J54 A3 2011",
"barcode": "645398607547",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLoanType": {
"id": "8e570d0d-931c-43d1-9ca1-221e693ea8d2",
"name": "Can Circulate"
},
"temporaryLoanType": {
"id": "74c25903-4019-4d8a-9360-5cb7761f44e5",
"name": "Course Reserve"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"inTransitDestinationServicePointId": "5b31ec8c-95a7-4b91-95cc-b551a74b91ca",
"tags" : {
"tagList" : [
"important"
]
}
}
HTTP status code 404
Item not found
Body
Media type: text/plain
Type: any
Example:
Item with such id not foundHTTP status code 422
Validation error
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server errorpost
post /inventory/items/{itemId}/mark-unknown
URI Parameters
- itemId: required(string)
HTTP status code 200
Item has marked as unknown
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An item record",
"type": "object",
"properties": {
"id": {
"description": "Item id",
"type": "string"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"description": "ID of the holdings record the item is a member of",
"type": "string"
},
"order": {
"type": "integer",
"description": "Order of the item in the holdings record."
},
"formerIds": {
"type": "array",
"description": "Previous identifiers assigned to the item",
"items": {
"type": "string"
},
"uniqueItems": true
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"displaySummary": {
"description": "Display summary about the item",
"type": "string"
},
"title": {
"type": "string",
"description": "Resouce title (read only, inherited from associated instance record)",
"readonly": true
},
"contributorNames": {
"description": "A list of contributor names",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The contributor name",
"type": "string"
}
}
}
},
"additionalCallNumbers": {
"description": "Additional Call Numbers to track the history of identifiers assigned to an item.",
"type": "array",
"items": {
"type": "object",
"uniqueItems": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An additional call number",
"properties": {
"typeId": {
"type": "string",
"description": "unique ID for the type of call number, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"prefix": {
"type": "string",
"description": "Prefix of the call number."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item or holding, usually printed on a label attached to the item."
},
"suffix": {
"type": "string",
"description": "Suffix of the call number."
}
},
"required": [
"callNumber"
]
}
},
"callNumber": {
"type": "string",
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record)",
"readonly": true
},
"barcode": {
"description": "Text, with input likely validated by the barcode scanner",
"type": "string"
},
"effectiveShelvingOrder": {
"type": "string",
"description": "A system generated normalization of the call number that allows for call number sorting in reports and search results",
"readonly": true
},
"accessionNumber": {
"type": "string",
"description": "Accession number is also called inventar number. Accession number is a unique number assigned to an item in the order in which it is added to a library collection. Most libraries assign accession numbers in continous numerical sequece, but some use a code system to indicate type of material and/or year of accession in addition to order of accession"
},
"itemLevelCallNumber": {
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record). The item level call number, is the call number on item level",
"type": "string"
},
"itemLevelCallNumberPrefix": {
"description": "Prefix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberSuffix": {
"description": "Suffix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberTypeId": {
"description": "Call number type, refers to a call-number-type reference record",
"type": "string"
},
"effectiveCallNumberComponents": {
"type": "object",
"description": "Elements of a full call number generated from the item or holding",
"properties": {
"callNumber": {
"type": "string",
"description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"prefix": {
"type": "string",
"description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"suffix": {
"type": "string",
"description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"typeId": {
"type": "string",
"description": "Effective Call Number Type Id is the call number type id assigned to the item or associated holding.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"volume": {
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of Gerorge Bernard Shaw in three volumes)",
"type": "string"
},
"enumeration": {
"description": "Enumeration is the descriptive information for the numbering scheme of a serial, usually identified by level and a descriptive caption, e.g., level 0 = v. and level 1 = no. This means that each issue of the serial has a volume and an issue number that would appear (e.g. v.71:no.6-2)",
"type": "string"
},
"chronology": {
"description": "Chronology is the descriptive information for the dating scheme of a serial, usually identified by level, e.g., level 0 = year level 1 = month. This means that each issue of the serial has a month and a year on each issue (e.g. 1985:July-Dec.)",
"type": "string"
},
"yearCaption": {
"description": "In multipart monographs, a caption is characters used to label a level of chronology (e.g. 'year 1985')",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"description": "Item identifier number, e.g. imported from the union catalogue (read only)",
"type": "string"
},
"copyNumber": {
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; a copy of a multi-volume, (e.g. Copy 1, or C.7.)",
"type": "string"
},
"numberOfPieces": {
"description": "Number of pieces. Used when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set)",
"type": "string"
},
"descriptionOfPieces": {
"description": "Text which descripe the pieces",
"type": "string"
},
"numberOfMissingPieces": {
"description": "Number of missing pieces",
"type": "string"
},
"missingPieces": {
"description": "Text which descripes the missing pieces",
"type": "string"
},
"missingPiecesDate": {
"description": "Date when the piece(s) went missing",
"type": "string"
},
"itemDamagedStatusId": {
"description": "Item Damage status Id, refers to an Item damage Status ID reference record",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date when damage status was last changed",
"type": "string"
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"description": "notes",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Note for item record",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.ItemNotes",
"additionalProperties": false,
"properties": {
"itemNoteTypeId": {
"description": "Item note type, refers to a item-note-type reference record",
"type": "string"
},
"note": {
"description": "Text to display (e.g. action note, binding, use and reproduction)",
"type": "string"
},
"staffOnly": {
"description": "Records the fact that the record should only be displayed for staff",
"type": "boolean",
"default": false
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"noteType": {
"type": "string",
"description": "Type of circulation process that the note applies to",
"enum": [
"Check in",
"Check out"
]
},
"note": {
"type": "string",
"description": "Text to display"
},
"staffOnly": {
"type": "boolean",
"description": "Records the fact that the note should only be displayed for staff",
"default": false
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting.",
"readonly": true,
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note",
"readonly": true
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"readonly": true,
"properties": {
"lastName": {
"type": "string",
"description": "The user's last name",
"readonly": true
},
"firstName": {
"type": "string",
"description": "The user's first name",
"readonly": true
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting.",
"readonly": true
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the item state (e.g. Available, Checked out, In transit, Awaiting pickup, On order). Default value is set to: Available",
"type": "string",
"enum": [
"Aged to lost",
"Available",
"Awaiting delivery",
"Awaiting pickup",
"Checked out",
"Claimed returned",
"Declared lost",
"Lost and paid",
"Long missing",
"Missing",
"In process",
"In process (non-requestable)",
"In transit",
"Intellectual item",
"On order",
"Order closed",
"Paged",
"Restricted",
"Unavailable",
"Unknown",
"Withdrawn"
]
},
"date": {
"description": "Date of the current item state. E.g. date set when item state was changed by the Check out app",
"type": "string",
"readonly": true,
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"materialType": {
"description": "Material type define what type of thing the item is",
"type": "object",
"properties": {
"id": {
"description": "Material type Id, refers to a material type reference record",
"type": "string"
},
"name": {
"description": "Material type name (e.g. Audio book, Audio disc, Computer file, Pamphelet) ",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"isBoundWith": {
"description": "Indicates if this Item is a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"boundWithTitles": {
"description": "List of titles that are bound together within this Item",
"type": "array",
"items": {
"type": "object",
"description": "A title that is bound with other titles within this Item",
"properties": {
"briefHoldingsRecord": {
"type": "object",
"description": "Information about a holdings record that links a title to the bound-with Item",
"properties": {
"id": {
"description": "The UUID of the holdingsRecord",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the holdingsRecord",
"type": "string"
}
},
"additionalProperties": false
},
"briefInstance": {
"type": "object",
"description": "Information about an Instance / title that is bound with other title within this Item",
"properties": {
"id": {
"description": "The UUID of the Instance",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the Instance",
"type": "string"
},
"title": {
"description": "The title of the Instance",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"readonly": true
},
"permanentLoanType": {
"description": "Permanent loan type, is the default loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Permanent loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Permanent loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLoanType": {
"description": "Temporary loan type, is the temporary loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Temporary loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Temporary loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"permanentLocation": {
"description": "Permanent item location is the default location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Permanent location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Permanent location type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLocation": {
"description": "Temporary item location is the temporarily location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Temporary location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Temporary location name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"effectiveLocation": {
"type": "object",
"description": "The effective location is used by FOLIO and other integrated systems to know the current home location for the item (read only, derived from locations on HoldingsRecord and Item)",
"readonly": true,
"properties": {
"id": {
"type": "string",
"readonly": true
},
"name": {
"description": "Effective location name",
"type": "string",
"readonly": true
}
}
},
"electronicAccess": {
"description": "Whether an item is available electronically",
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "Link text is used for display in place of the URL"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id, refers to a Relationship type reference record. Relationship between the electronic resource at the location identified and the item described in the record as a whole. (E.g. values from MARC 21, tag field 856 2nd indicator, where the values are: No information provided, Resource, Version of resource, Related resource, No display constant generate"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "Statistical code Id, refers to a Statistical code reference record",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"tags": {
"description": "arbitrary tags associated with this item",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last checked in",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time",
"readonly": true
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"staffMemberId": {
"type": "string",
"description": "ID a staff member who scanned the item",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
},
"additionalProperties": false,
"required": [
"materialType",
"permanentLoanType",
"status"
]
}Example:
{
"id": "0b96a642-5e7f-452d-9cae-9cee66c9a892",
"title": "Uprooted",
"contributorNames": [{ "name": "Novik, Naomi" }],
"callNumber": "D11.J54 A3 2011",
"barcode": "645398607547",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLoanType": {
"id": "8e570d0d-931c-43d1-9ca1-221e693ea8d2",
"name": "Can Circulate"
},
"temporaryLoanType": {
"id": "74c25903-4019-4d8a-9360-5cb7761f44e5",
"name": "Course Reserve"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"inTransitDestinationServicePointId": "5b31ec8c-95a7-4b91-95cc-b551a74b91ca",
"tags" : {
"tagList" : [
"important"
]
}
}
HTTP status code 404
Item not found
Body
Media type: text/plain
Type: any
Example:
Item with such id not foundHTTP status code 422
Validation error
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server errorCollection of items-by-holdings-id items.
get
Retrieve a list of items-by-holdings-id items.
post
Create a new items-by-holdings-id item.
get /inventory/items-by-holdings-id
Retrieve a list of items-by-holdings-id items.
Query Parameters
- offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)
Skip over a number of elements by specifying an offset value for the query
Example:
0 - limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)
Limit the number of elements returned in the response
Example:
10 - query: (string)
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
query by holdings record ID. This is a mandatory query parameter. An optional parameter, 'relations', can be passed outside of the query to restrict what Items are returned based on their type of relationship with the holdings record. Possible values of the 'relations' parameter are: 'onlyBoundWiths', 'onlyBoundWithsSkipDirectlyLinkedItem'
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode holdingsRecordId=="[UUID]" - lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 200
Returns a list of items-by-holdings-id items
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A collection of item records",
"type": "object",
"properties": {
"items": {
"description": "List of item records",
"id": "items",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An item record",
"properties": {
"id": {
"description": "Item id",
"type": "string"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"description": "ID of the holdings record the item is a member of",
"type": "string"
},
"order": {
"type": "integer",
"description": "Order of the item in the holdings record."
},
"formerIds": {
"type": "array",
"description": "Previous identifiers assigned to the item",
"items": {
"type": "string"
},
"uniqueItems": true
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"displaySummary": {
"description": "Display summary about the item",
"type": "string"
},
"title": {
"type": "string",
"description": "Resouce title (read only, inherited from associated instance record)",
"readonly": true
},
"contributorNames": {
"description": "A list of contributor names",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The contributor name",
"type": "string"
}
}
}
},
"additionalCallNumbers": {
"description": "Additional Call Numbers to track the history of identifiers assigned to an item.",
"type": "array",
"items": {
"type": "object",
"uniqueItems": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An additional call number",
"properties": {
"typeId": {
"type": "string",
"description": "unique ID for the type of call number, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"prefix": {
"type": "string",
"description": "Prefix of the call number."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item or holding, usually printed on a label attached to the item."
},
"suffix": {
"type": "string",
"description": "Suffix of the call number."
}
},
"required": [
"callNumber"
]
}
},
"callNumber": {
"type": "string",
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record)",
"readonly": true
},
"barcode": {
"description": "Text, with input likely validated by the barcode scanner",
"type": "string"
},
"effectiveShelvingOrder": {
"type": "string",
"description": "A system generated normalization of the call number that allows for call number sorting in reports and search results",
"readonly": true
},
"accessionNumber": {
"type": "string",
"description": "Accession number is also called inventar number. Accession number is a unique number assigned to an item in the order in which it is added to a library collection. Most libraries assign accession numbers in continous numerical sequece, but some use a code system to indicate type of material and/or year of accession in addition to order of accession"
},
"itemLevelCallNumber": {
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record). The item level call number, is the call number on item level",
"type": "string"
},
"itemLevelCallNumberPrefix": {
"description": "Prefix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberSuffix": {
"description": "Suffix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberTypeId": {
"description": "Call number type, refers to a call-number-type reference record",
"type": "string"
},
"effectiveCallNumberComponents": {
"type": "object",
"description": "Elements of a full call number generated from the item or holding",
"properties": {
"callNumber": {
"type": "string",
"description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"prefix": {
"type": "string",
"description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"suffix": {
"type": "string",
"description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"typeId": {
"type": "string",
"description": "Effective Call Number Type Id is the call number type id assigned to the item or associated holding.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"volume": {
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of Gerorge Bernard Shaw in three volumes)",
"type": "string"
},
"enumeration": {
"description": "Enumeration is the descriptive information for the numbering scheme of a serial, usually identified by level and a descriptive caption, e.g., level 0 = v. and level 1 = no. This means that each issue of the serial has a volume and an issue number that would appear (e.g. v.71:no.6-2)",
"type": "string"
},
"chronology": {
"description": "Chronology is the descriptive information for the dating scheme of a serial, usually identified by level, e.g., level 0 = year level 1 = month. This means that each issue of the serial has a month and a year on each issue (e.g. 1985:July-Dec.)",
"type": "string"
},
"yearCaption": {
"description": "In multipart monographs, a caption is characters used to label a level of chronology (e.g. 'year 1985')",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"description": "Item identifier number, e.g. imported from the union catalogue (read only)",
"type": "string"
},
"copyNumber": {
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; a copy of a multi-volume, (e.g. Copy 1, or C.7.)",
"type": "string"
},
"numberOfPieces": {
"description": "Number of pieces. Used when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set)",
"type": "string"
},
"descriptionOfPieces": {
"description": "Text which descripe the pieces",
"type": "string"
},
"numberOfMissingPieces": {
"description": "Number of missing pieces",
"type": "string"
},
"missingPieces": {
"description": "Text which descripes the missing pieces",
"type": "string"
},
"missingPiecesDate": {
"description": "Date when the piece(s) went missing",
"type": "string"
},
"itemDamagedStatusId": {
"description": "Item Damage status Id, refers to an Item damage Status ID reference record",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date when damage status was last changed",
"type": "string"
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"description": "notes",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Note for item record",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.ItemNotes",
"additionalProperties": false,
"properties": {
"itemNoteTypeId": {
"description": "Item note type, refers to a item-note-type reference record",
"type": "string"
},
"note": {
"description": "Text to display (e.g. action note, binding, use and reproduction)",
"type": "string"
},
"staffOnly": {
"description": "Records the fact that the record should only be displayed for staff",
"type": "boolean",
"default": false
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"noteType": {
"type": "string",
"description": "Type of circulation process that the note applies to",
"enum": [
"Check in",
"Check out"
]
},
"note": {
"type": "string",
"description": "Text to display"
},
"staffOnly": {
"type": "boolean",
"description": "Records the fact that the note should only be displayed for staff",
"default": false
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting.",
"readonly": true,
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note",
"readonly": true
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"readonly": true,
"properties": {
"lastName": {
"type": "string",
"description": "The user's last name",
"readonly": true
},
"firstName": {
"type": "string",
"description": "The user's first name",
"readonly": true
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting.",
"readonly": true
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the item state (e.g. Available, Checked out, In transit, Awaiting pickup, On order). Default value is set to: Available",
"type": "string",
"enum": [
"Aged to lost",
"Available",
"Awaiting delivery",
"Awaiting pickup",
"Checked out",
"Claimed returned",
"Declared lost",
"Lost and paid",
"Long missing",
"Missing",
"In process",
"In process (non-requestable)",
"In transit",
"Intellectual item",
"On order",
"Order closed",
"Paged",
"Restricted",
"Unavailable",
"Unknown",
"Withdrawn"
]
},
"date": {
"description": "Date of the current item state. E.g. date set when item state was changed by the Check out app",
"type": "string",
"readonly": true,
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"materialType": {
"description": "Material type define what type of thing the item is",
"type": "object",
"properties": {
"id": {
"description": "Material type Id, refers to a material type reference record",
"type": "string"
},
"name": {
"description": "Material type name (e.g. Audio book, Audio disc, Computer file, Pamphelet) ",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"isBoundWith": {
"description": "Indicates if this Item is a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"boundWithTitles": {
"description": "List of titles that are bound together within this Item",
"type": "array",
"items": {
"type": "object",
"description": "A title that is bound with other titles within this Item",
"properties": {
"briefHoldingsRecord": {
"type": "object",
"description": "Information about a holdings record that links a title to the bound-with Item",
"properties": {
"id": {
"description": "The UUID of the holdingsRecord",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the holdingsRecord",
"type": "string"
}
},
"additionalProperties": false
},
"briefInstance": {
"type": "object",
"description": "Information about an Instance / title that is bound with other title within this Item",
"properties": {
"id": {
"description": "The UUID of the Instance",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the Instance",
"type": "string"
},
"title": {
"description": "The title of the Instance",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"readonly": true
},
"permanentLoanType": {
"description": "Permanent loan type, is the default loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Permanent loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Permanent loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLoanType": {
"description": "Temporary loan type, is the temporary loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Temporary loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Temporary loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"permanentLocation": {
"description": "Permanent item location is the default location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Permanent location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Permanent location type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLocation": {
"description": "Temporary item location is the temporarily location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Temporary location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Temporary location name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"effectiveLocation": {
"type": "object",
"description": "The effective location is used by FOLIO and other integrated systems to know the current home location for the item (read only, derived from locations on HoldingsRecord and Item)",
"readonly": true,
"properties": {
"id": {
"type": "string",
"readonly": true
},
"name": {
"description": "Effective location name",
"type": "string",
"readonly": true
}
}
},
"electronicAccess": {
"description": "Whether an item is available electronically",
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "Link text is used for display in place of the URL"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id, refers to a Relationship type reference record. Relationship between the electronic resource at the location identified and the item described in the record as a whole. (E.g. values from MARC 21, tag field 856 2nd indicator, where the values are: No information provided, Resource, Version of resource, Related resource, No display constant generate"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "Statistical code Id, refers to a Statistical code reference record",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"tags": {
"description": "arbitrary tags associated with this item",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last checked in",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time",
"readonly": true
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"staffMemberId": {
"type": "string",
"description": "ID a staff member who scanned the item",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
},
"additionalProperties": false,
"required": [
"materialType",
"permanentLoanType",
"status"
]
}
},
"totalRecords": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"items",
"totalRecords"
]
}Example:
{
"items": [
{
"id": "43ec57e3-3974-4d05-a2c2-95126e087b72",
"title": "Nod",
"barcode": "456743454532",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"permanentLoanType": {
"id": "11477028-d9e6-44d2-9364-5c6f51053f51",
"name": "Reading Room"
},
"tags" : {
"tagList" : [
"important"
]
}
},
{
"id": "0b96a642-5e7f-452d-9cae-9cee66c9a892",
"title": "Uprooted",
"callNumber": "D11.J54 A3 2011",
"barcode": "645398607547",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLoanType": {
"id": "8e570d0d-931c-43d1-9ca1-221e693ea8d2",
"name": "Can Circulate"
},
"temporaryLoanType": {
"id": "74c25903-4019-4d8a-9360-5cb7761f44e5",
"name": "Course Reserve"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"temporaryLocation": {
"id": "0df935eb-f3f4-4741-9ac6-33c500174b96",
"name": "Annex"
},
"tags" : {
"tagList" : [
"important"
]
}
}
],
"totalRecords": 2
}
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
unable to list items-by-holdings-id -- malformed parameter 'query', syntax error at column 6HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to list items-by-holdings-id -- unauthorizedHTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorpost /inventory/items-by-holdings-id
Create a new items-by-holdings-id item.
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An item record",
"type": "object",
"properties": {
"id": {
"description": "Item id",
"type": "string"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"description": "ID of the holdings record the item is a member of",
"type": "string"
},
"order": {
"type": "integer",
"description": "Order of the item in the holdings record."
},
"formerIds": {
"type": "array",
"description": "Previous identifiers assigned to the item",
"items": {
"type": "string"
},
"uniqueItems": true
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"displaySummary": {
"description": "Display summary about the item",
"type": "string"
},
"title": {
"type": "string",
"description": "Resouce title (read only, inherited from associated instance record)",
"readonly": true
},
"contributorNames": {
"description": "A list of contributor names",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The contributor name",
"type": "string"
}
}
}
},
"additionalCallNumbers": {
"description": "Additional Call Numbers to track the history of identifiers assigned to an item.",
"type": "array",
"items": {
"type": "object",
"uniqueItems": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An additional call number",
"properties": {
"typeId": {
"type": "string",
"description": "unique ID for the type of call number, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"prefix": {
"type": "string",
"description": "Prefix of the call number."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item or holding, usually printed on a label attached to the item."
},
"suffix": {
"type": "string",
"description": "Suffix of the call number."
}
},
"required": [
"callNumber"
]
}
},
"callNumber": {
"type": "string",
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record)",
"readonly": true
},
"barcode": {
"description": "Text, with input likely validated by the barcode scanner",
"type": "string"
},
"effectiveShelvingOrder": {
"type": "string",
"description": "A system generated normalization of the call number that allows for call number sorting in reports and search results",
"readonly": true
},
"accessionNumber": {
"type": "string",
"description": "Accession number is also called inventar number. Accession number is a unique number assigned to an item in the order in which it is added to a library collection. Most libraries assign accession numbers in continous numerical sequece, but some use a code system to indicate type of material and/or year of accession in addition to order of accession"
},
"itemLevelCallNumber": {
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record). The item level call number, is the call number on item level",
"type": "string"
},
"itemLevelCallNumberPrefix": {
"description": "Prefix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberSuffix": {
"description": "Suffix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberTypeId": {
"description": "Call number type, refers to a call-number-type reference record",
"type": "string"
},
"effectiveCallNumberComponents": {
"type": "object",
"description": "Elements of a full call number generated from the item or holding",
"properties": {
"callNumber": {
"type": "string",
"description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"prefix": {
"type": "string",
"description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"suffix": {
"type": "string",
"description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"typeId": {
"type": "string",
"description": "Effective Call Number Type Id is the call number type id assigned to the item or associated holding.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"volume": {
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of Gerorge Bernard Shaw in three volumes)",
"type": "string"
},
"enumeration": {
"description": "Enumeration is the descriptive information for the numbering scheme of a serial, usually identified by level and a descriptive caption, e.g., level 0 = v. and level 1 = no. This means that each issue of the serial has a volume and an issue number that would appear (e.g. v.71:no.6-2)",
"type": "string"
},
"chronology": {
"description": "Chronology is the descriptive information for the dating scheme of a serial, usually identified by level, e.g., level 0 = year level 1 = month. This means that each issue of the serial has a month and a year on each issue (e.g. 1985:July-Dec.)",
"type": "string"
},
"yearCaption": {
"description": "In multipart monographs, a caption is characters used to label a level of chronology (e.g. 'year 1985')",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"description": "Item identifier number, e.g. imported from the union catalogue (read only)",
"type": "string"
},
"copyNumber": {
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; a copy of a multi-volume, (e.g. Copy 1, or C.7.)",
"type": "string"
},
"numberOfPieces": {
"description": "Number of pieces. Used when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set)",
"type": "string"
},
"descriptionOfPieces": {
"description": "Text which descripe the pieces",
"type": "string"
},
"numberOfMissingPieces": {
"description": "Number of missing pieces",
"type": "string"
},
"missingPieces": {
"description": "Text which descripes the missing pieces",
"type": "string"
},
"missingPiecesDate": {
"description": "Date when the piece(s) went missing",
"type": "string"
},
"itemDamagedStatusId": {
"description": "Item Damage status Id, refers to an Item damage Status ID reference record",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date when damage status was last changed",
"type": "string"
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"description": "notes",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Note for item record",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.ItemNotes",
"additionalProperties": false,
"properties": {
"itemNoteTypeId": {
"description": "Item note type, refers to a item-note-type reference record",
"type": "string"
},
"note": {
"description": "Text to display (e.g. action note, binding, use and reproduction)",
"type": "string"
},
"staffOnly": {
"description": "Records the fact that the record should only be displayed for staff",
"type": "boolean",
"default": false
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"noteType": {
"type": "string",
"description": "Type of circulation process that the note applies to",
"enum": [
"Check in",
"Check out"
]
},
"note": {
"type": "string",
"description": "Text to display"
},
"staffOnly": {
"type": "boolean",
"description": "Records the fact that the note should only be displayed for staff",
"default": false
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting.",
"readonly": true,
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note",
"readonly": true
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"readonly": true,
"properties": {
"lastName": {
"type": "string",
"description": "The user's last name",
"readonly": true
},
"firstName": {
"type": "string",
"description": "The user's first name",
"readonly": true
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting.",
"readonly": true
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the item state (e.g. Available, Checked out, In transit, Awaiting pickup, On order). Default value is set to: Available",
"type": "string",
"enum": [
"Aged to lost",
"Available",
"Awaiting delivery",
"Awaiting pickup",
"Checked out",
"Claimed returned",
"Declared lost",
"Lost and paid",
"Long missing",
"Missing",
"In process",
"In process (non-requestable)",
"In transit",
"Intellectual item",
"On order",
"Order closed",
"Paged",
"Restricted",
"Unavailable",
"Unknown",
"Withdrawn"
]
},
"date": {
"description": "Date of the current item state. E.g. date set when item state was changed by the Check out app",
"type": "string",
"readonly": true,
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"materialType": {
"description": "Material type define what type of thing the item is",
"type": "object",
"properties": {
"id": {
"description": "Material type Id, refers to a material type reference record",
"type": "string"
},
"name": {
"description": "Material type name (e.g. Audio book, Audio disc, Computer file, Pamphelet) ",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"isBoundWith": {
"description": "Indicates if this Item is a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"boundWithTitles": {
"description": "List of titles that are bound together within this Item",
"type": "array",
"items": {
"type": "object",
"description": "A title that is bound with other titles within this Item",
"properties": {
"briefHoldingsRecord": {
"type": "object",
"description": "Information about a holdings record that links a title to the bound-with Item",
"properties": {
"id": {
"description": "The UUID of the holdingsRecord",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the holdingsRecord",
"type": "string"
}
},
"additionalProperties": false
},
"briefInstance": {
"type": "object",
"description": "Information about an Instance / title that is bound with other title within this Item",
"properties": {
"id": {
"description": "The UUID of the Instance",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the Instance",
"type": "string"
},
"title": {
"description": "The title of the Instance",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"readonly": true
},
"permanentLoanType": {
"description": "Permanent loan type, is the default loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Permanent loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Permanent loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLoanType": {
"description": "Temporary loan type, is the temporary loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Temporary loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Temporary loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"permanentLocation": {
"description": "Permanent item location is the default location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Permanent location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Permanent location type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLocation": {
"description": "Temporary item location is the temporarily location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Temporary location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Temporary location name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"effectiveLocation": {
"type": "object",
"description": "The effective location is used by FOLIO and other integrated systems to know the current home location for the item (read only, derived from locations on HoldingsRecord and Item)",
"readonly": true,
"properties": {
"id": {
"type": "string",
"readonly": true
},
"name": {
"description": "Effective location name",
"type": "string",
"readonly": true
}
}
},
"electronicAccess": {
"description": "Whether an item is available electronically",
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "Link text is used for display in place of the URL"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id, refers to a Relationship type reference record. Relationship between the electronic resource at the location identified and the item described in the record as a whole. (E.g. values from MARC 21, tag field 856 2nd indicator, where the values are: No information provided, Resource, Version of resource, Related resource, No display constant generate"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "Statistical code Id, refers to a Statistical code reference record",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"tags": {
"description": "arbitrary tags associated with this item",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last checked in",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time",
"readonly": true
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"staffMemberId": {
"type": "string",
"description": "ID a staff member who scanned the item",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
},
"additionalProperties": false,
"required": [
"materialType",
"permanentLoanType",
"status"
]
}Example:
{
"items": [
{
"id": "43ec57e3-3974-4d05-a2c2-95126e087b72",
"title": "Nod",
"barcode": "456743454532",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"permanentLoanType": {
"id": "11477028-d9e6-44d2-9364-5c6f51053f51",
"name": "Reading Room"
},
"tags" : {
"tagList" : [
"important"
]
}
},
{
"id": "0b96a642-5e7f-452d-9cae-9cee66c9a892",
"title": "Uprooted",
"callNumber": "D11.J54 A3 2011",
"barcode": "645398607547",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLoanType": {
"id": "8e570d0d-931c-43d1-9ca1-221e693ea8d2",
"name": "Can Circulate"
},
"temporaryLoanType": {
"id": "74c25903-4019-4d8a-9360-5cb7761f44e5",
"name": "Course Reserve"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"temporaryLocation": {
"id": "0df935eb-f3f4-4741-9ac6-33c500174b96",
"name": "Annex"
},
"tags" : {
"tagList" : [
"important"
]
}
}
],
"totalRecords": 2
}
HTTP status code 201
Returns a newly created item, with server-controlled fields like 'id' populated
Headers
- Location: required(string)
URI to the created items-by-holdings-id item
Body
Media type: application/json
Type: any
Example:
{
"items": [
{
"id": "43ec57e3-3974-4d05-a2c2-95126e087b72",
"title": "Nod",
"barcode": "456743454532",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"permanentLoanType": {
"id": "11477028-d9e6-44d2-9364-5c6f51053f51",
"name": "Reading Room"
},
"tags" : {
"tagList" : [
"important"
]
}
},
{
"id": "0b96a642-5e7f-452d-9cae-9cee66c9a892",
"title": "Uprooted",
"callNumber": "D11.J54 A3 2011",
"barcode": "645398607547",
"status": {
"name": "Available"
},
"materialType": {
"id": "fcf3d3dc-b27f-4ce4-a530-542ea53cacb5",
"name": "Book"
},
"permanentLoanType": {
"id": "8e570d0d-931c-43d1-9ca1-221e693ea8d2",
"name": "Can Circulate"
},
"temporaryLoanType": {
"id": "74c25903-4019-4d8a-9360-5cb7761f44e5",
"name": "Course Reserve"
},
"permanentLocation": {
"id": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
"name": "Main Library"
},
"temporaryLocation": {
"id": "0df935eb-f3f4-4741-9ac6-33c500174b96",
"name": "Annex"
},
"tags" : {
"tagList" : [
"important"
]
}
}
],
"totalRecords": 2
}
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to add items-by-holdings-id -- malformed JSON at 13:3"
HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to create items-by-holdings-id -- unauthorizedHTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorpost
post /inventory/tenant-items
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of pairs of item and tenant IDs",
"type": "object",
"properties": {
"tenantItemPairs": {
"type": "array",
"description": "Pairs of tenantId and itemId",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Pair of item and tenant IDs",
"properties": {
"tenantId": {
"type": "string",
"description": "Unique ID of the tenant where the item is located"
},
"itemId": {
"type": "string",
"description": "Unique ID (UUID) of the item",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"additionalProperties": false,
"required": [
"itemId",
"tenantId"
]
}
}
},
"additionalProperties": false,
"required": [
"tenantItemPairs"
]
}HTTP status code 200
Fetched items based on tenant IDs
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A collection of item records",
"type": "object",
"properties": {
"items": {
"description": "List of item records",
"id": "items",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An item record",
"properties": {
"id": {
"description": "Item id",
"type": "string"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"description": "ID of the holdings record the item is a member of",
"type": "string"
},
"order": {
"type": "integer",
"description": "Order of the item in the holdings record."
},
"formerIds": {
"type": "array",
"description": "Previous identifiers assigned to the item",
"items": {
"type": "string"
},
"uniqueItems": true
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"displaySummary": {
"description": "Display summary about the item",
"type": "string"
},
"title": {
"type": "string",
"description": "Resouce title (read only, inherited from associated instance record)",
"readonly": true
},
"contributorNames": {
"description": "A list of contributor names",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The contributor name",
"type": "string"
}
}
}
},
"additionalCallNumbers": {
"description": "Additional Call Numbers to track the history of identifiers assigned to an item.",
"type": "array",
"items": {
"type": "object",
"uniqueItems": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An additional call number",
"properties": {
"typeId": {
"type": "string",
"description": "unique ID for the type of call number, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"prefix": {
"type": "string",
"description": "Prefix of the call number."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item or holding, usually printed on a label attached to the item."
},
"suffix": {
"type": "string",
"description": "Suffix of the call number."
}
},
"required": [
"callNumber"
]
}
},
"callNumber": {
"type": "string",
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record)",
"readonly": true
},
"barcode": {
"description": "Text, with input likely validated by the barcode scanner",
"type": "string"
},
"effectiveShelvingOrder": {
"type": "string",
"description": "A system generated normalization of the call number that allows for call number sorting in reports and search results",
"readonly": true
},
"accessionNumber": {
"type": "string",
"description": "Accession number is also called inventar number. Accession number is a unique number assigned to an item in the order in which it is added to a library collection. Most libraries assign accession numbers in continous numerical sequece, but some use a code system to indicate type of material and/or year of accession in addition to order of accession"
},
"itemLevelCallNumber": {
"description": "Call number is an identifier assigned to an item, usually printed on a label attached to the item, and used to determine its physical position in a shelving sequence (e.g. K1 .M44, read only, inherited from associated holdings record). The item level call number, is the call number on item level",
"type": "string"
},
"itemLevelCallNumberPrefix": {
"description": "Prefix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberSuffix": {
"description": "Suffix of the call number on the item level",
"type": "string"
},
"itemLevelCallNumberTypeId": {
"description": "Call number type, refers to a call-number-type reference record",
"type": "string"
},
"effectiveCallNumberComponents": {
"type": "object",
"description": "Elements of a full call number generated from the item or holding",
"properties": {
"callNumber": {
"type": "string",
"description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"prefix": {
"type": "string",
"description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"suffix": {
"type": "string",
"description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.",
"readonly": true
},
"typeId": {
"type": "string",
"description": "Effective Call Number Type Id is the call number type id assigned to the item or associated holding.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"volume": {
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of Gerorge Bernard Shaw in three volumes)",
"type": "string"
},
"enumeration": {
"description": "Enumeration is the descriptive information for the numbering scheme of a serial, usually identified by level and a descriptive caption, e.g., level 0 = v. and level 1 = no. This means that each issue of the serial has a volume and an issue number that would appear (e.g. v.71:no.6-2)",
"type": "string"
},
"chronology": {
"description": "Chronology is the descriptive information for the dating scheme of a serial, usually identified by level, e.g., level 0 = year level 1 = month. This means that each issue of the serial has a month and a year on each issue (e.g. 1985:July-Dec.)",
"type": "string"
},
"yearCaption": {
"description": "In multipart monographs, a caption is characters used to label a level of chronology (e.g. 'year 1985')",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"description": "Item identifier number, e.g. imported from the union catalogue (read only)",
"type": "string"
},
"copyNumber": {
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; a copy of a multi-volume, (e.g. Copy 1, or C.7.)",
"type": "string"
},
"numberOfPieces": {
"description": "Number of pieces. Used when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set)",
"type": "string"
},
"descriptionOfPieces": {
"description": "Text which descripe the pieces",
"type": "string"
},
"numberOfMissingPieces": {
"description": "Number of missing pieces",
"type": "string"
},
"missingPieces": {
"description": "Text which descripes the missing pieces",
"type": "string"
},
"missingPiecesDate": {
"description": "Date when the piece(s) went missing",
"type": "string"
},
"itemDamagedStatusId": {
"description": "Item Damage status Id, refers to an Item damage Status ID reference record",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date when damage status was last changed",
"type": "string"
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"description": "notes",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Note for item record",
"type": "object",
"javaType": "org.folio.rest.jaxrs.model.ItemNotes",
"additionalProperties": false,
"properties": {
"itemNoteTypeId": {
"description": "Item note type, refers to a item-note-type reference record",
"type": "string"
},
"note": {
"description": "Text to display (e.g. action note, binding, use and reproduction)",
"type": "string"
},
"staffOnly": {
"description": "Records the fact that the record should only be displayed for staff",
"type": "boolean",
"default": false
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"noteType": {
"type": "string",
"description": "Type of circulation process that the note applies to",
"enum": [
"Check in",
"Check out"
]
},
"note": {
"type": "string",
"description": "Text to display"
},
"staffOnly": {
"type": "boolean",
"description": "Records the fact that the note should only be displayed for staff",
"default": false
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting.",
"readonly": true,
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note",
"readonly": true
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"readonly": true,
"properties": {
"lastName": {
"type": "string",
"description": "The user's last name",
"readonly": true
},
"firstName": {
"type": "string",
"description": "The user's first name",
"readonly": true
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting.",
"readonly": true
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the item state (e.g. Available, Checked out, In transit, Awaiting pickup, On order). Default value is set to: Available",
"type": "string",
"enum": [
"Aged to lost",
"Available",
"Awaiting delivery",
"Awaiting pickup",
"Checked out",
"Claimed returned",
"Declared lost",
"Lost and paid",
"Long missing",
"Missing",
"In process",
"In process (non-requestable)",
"In transit",
"Intellectual item",
"On order",
"Order closed",
"Paged",
"Restricted",
"Unavailable",
"Unknown",
"Withdrawn"
]
},
"date": {
"description": "Date of the current item state. E.g. date set when item state was changed by the Check out app",
"type": "string",
"readonly": true,
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"materialType": {
"description": "Material type define what type of thing the item is",
"type": "object",
"properties": {
"id": {
"description": "Material type Id, refers to a material type reference record",
"type": "string"
},
"name": {
"description": "Material type name (e.g. Audio book, Audio disc, Computer file, Pamphelet) ",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"isBoundWith": {
"description": "Indicates if this Item is a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"boundWithTitles": {
"description": "List of titles that are bound together within this Item",
"type": "array",
"items": {
"type": "object",
"description": "A title that is bound with other titles within this Item",
"properties": {
"briefHoldingsRecord": {
"type": "object",
"description": "Information about a holdings record that links a title to the bound-with Item",
"properties": {
"id": {
"description": "The UUID of the holdingsRecord",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the holdingsRecord",
"type": "string"
}
},
"additionalProperties": false
},
"briefInstance": {
"type": "object",
"description": "Information about an Instance / title that is bound with other title within this Item",
"properties": {
"id": {
"description": "The UUID of the Instance",
"type": "string"
},
"hrid": {
"description": "The human-readable ID of the Instance",
"type": "string"
},
"title": {
"description": "The title of the Instance",
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"readonly": true
},
"permanentLoanType": {
"description": "Permanent loan type, is the default loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Permanent loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Permanent loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLoanType": {
"description": "Temporary loan type, is the temporary loan type for a given item. Loan types are tenant-defined in a reference table in Settings, Inventory, Item, Loan type (e.g. Can circulate, Course reserves, Reading room, Selected)",
"type": "object",
"properties": {
"id": {
"description": "Temporary loan type Id, refers to a loan type reference record",
"type": "string"
},
"name": {
"description": "Temporary loan type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"permanentLocation": {
"description": "Permanent item location is the default location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Permanent location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Permanent location type name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"temporaryLocation": {
"description": "Temporary item location is the temporarily location, shelving location, or holding which is a physical place where items are stored, or an Online location. The location is defined by Institutions, Campuses, libraries, and locations. Permanent location can be assigned at the holding level, and be overridden at the item level if needed",
"type": "object",
"properties": {
"id": {
"description": "Temporary location Id, refers to a location type reference record",
"type": "string"
},
"name": {
"description": "Temporary location name",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id"
]
},
"effectiveLocation": {
"type": "object",
"description": "The effective location is used by FOLIO and other integrated systems to know the current home location for the item (read only, derived from locations on HoldingsRecord and Item)",
"readonly": true,
"properties": {
"id": {
"type": "string",
"readonly": true
},
"name": {
"description": "Effective location name",
"type": "string",
"readonly": true
}
}
},
"electronicAccess": {
"description": "Whether an item is available electronically",
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "Link text is used for display in place of the URL"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id, refers to a Relationship type reference record. Relationship between the electronic resource at the location identified and the item described in the record as a whole. (E.g. values from MARC 21, tag field 856 2nd indicator, where the values are: No information provided, Resource, Version of resource, Related resource, No display constant generate"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "Statistical code Id, refers to a Statistical code reference record",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"metadata": {
"description": "Metadata about creation and changes, provided by the server (client should not provide)",
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"tags": {
"description": "arbitrary tags associated with this item",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last checked in",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time",
"readonly": true
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"staffMemberId": {
"type": "string",
"description": "ID a staff member who scanned the item",
"readonly": true,
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
}
},
"additionalProperties": false,
"required": [
"materialType",
"permanentLoanType",
"status"
]
}
},
"totalRecords": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"items",
"totalRecords"
]
}put
Update Holdings by holdingsId
put /inventory/holdings/{holdingsId}
Update Holdings by holdingsId
URI Parameters
- holdingsId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A holdings record",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the system assigned unique ID of the holdings record; UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "the human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"holdingsTypeId": {
"type": "string",
"description": "unique ID for the type of this holdings record, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"formerIds": {
"type": "array",
"description": "Previous ID(s) assigned to the holdings record",
"items": {
"type": "string"
},
"uniqueItems": true
},
"instanceId": {
"description": "Instance id",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"permanentLocationId": {
"type": "string",
"description": "The permanent shelving location in which an item resides.",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"temporaryLocationId": {
"type": "string",
"description": "Temporary location is the temporary location, shelving location, or holding which is a physical place where items are stored, or an Online location.",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"effectiveLocationId": {
"type": "string",
"description": "Effective location is calculated by the system based on the values in the permanent and temporary locationId fields.",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"electronicAccess": {
"description": "Electronic access",
"type": "array",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "uniform resource identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "the value of the MARC tag field 856 2nd indicator, where the values are: no information provided, resource, version of resource, related resource, no display constant generated"
},
"materialsSpecification": {
"type": "string",
"description": "materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "relationship between the electronic resource at the location identified and the item described in the record as a whole"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"additionalCallNumbers": {
"description": "Additional Call Numbers to track the history of identifiers assigned to an item.",
"type": "array",
"items": {
"type": "object",
"uniqueItems": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An additional call number",
"properties": {
"typeId": {
"type": "string",
"description": "unique ID for the type of call number, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"prefix": {
"type": "string",
"description": "Prefix of the call number."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item or holding, usually printed on a label attached to the item."
},
"suffix": {
"type": "string",
"description": "Suffix of the call number."
}
},
"required": [
"callNumber"
]
}
},
"callNumberTypeId": {
"type": "string",
"description": "unique ID for the type of call number on a holdings record, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"callNumberPrefix": {
"type": "string",
"description": "Prefix of the call number on the holding level."
},
"callNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item, usually printed on a label attached to the item."
},
"callNumberSuffix": {
"type": "string",
"description": "Suffix of the call number on the holding level."
},
"shelvingTitle": {
"type": "string",
"description": "Indicates the shelving form of title."
},
"acquisitionFormat": {
"description": "Acquisition format",
"type": "string"
},
"acquisitionMethod": {
"description": "Acquisition method",
"type": "string"
},
"receiptStatus": {
"type": "string",
"description": "Receipt status (e.g. pending, awaiting receipt, partially received, fully received, receipt not required, and cancelled)"
},
"notes": {
"description": "Notes about action, copy, binding etc.",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Note for holding record",
"javaType": "org.folio.rest.jaxrs.model.HoldingsNotes",
"additionalProperties": false,
"properties": {
"holdingsNoteTypeId": {
"type": "string",
"description": "ID of the type of note",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"note": {
"type": "string",
"description": "Text content of the note"
},
"staffOnly": {
"type": "boolean",
"description": "If true, determines that the note should not be visible for others than staff",
"default": false
}
}
}
},
"illPolicyId": {
"type": "string",
"description": "unique ID for an ILL policy, a UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"retentionPolicy": {
"type": "string",
"description": "Records information regarding how long we have agreed to keep something."
},
"digitizationPolicy": {
"description": "Digitization policy",
"type": "string"
},
"holdingsStatements": {
"type": "array",
"description": "Holdings statements",
"items": {
"type": "object",
"properties": {
"statement": {
"type": "string",
"description": "Specifices the exact content to which the library has access, typically for continuing publications."
},
"note": {
"type": "string",
"description": "Note attached to a holdings statement"
},
"staffNote": {
"type": "string",
"description": "Private note attached to a holdings statement"
}
}
}
},
"holdingsStatementsForIndexes": {
"description": "Holdings statements for indexes",
"type": "array",
"items": {
"type": "object",
"properties": {
"statement": {
"type": "string",
"description": "Textual description of the holdings of indexes"
},
"note": {
"type": "string",
"description": "Note attached to a holdings statement"
},
"staffNote": {
"type": "string",
"description": "Private note attached to a holdings statement"
}
}
}
},
"holdingsStatementsForSupplements": {
"description": "Holdings statements for supplements",
"type": "array",
"items": {
"type": "object",
"properties": {
"statement": {
"type": "string",
"description": "textual description of the holdings of supplementary material"
},
"note": {
"type": "string",
"description": "note attached to a holdings statement"
},
"staffNote": {
"type": "string",
"description": "Private note attached to a holdings statement"
}
}
}
},
"copyNumber": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Text (Number)"
},
"receivingHistory": {
"description": "Receiving history",
"type": "object",
"properties": {
"displayType": {
"type": "string",
"description": "Display hint. 1: Display fields separately. 2: Display fields concatenated"
},
"entries": {
"type": "array",
"description": "Entries",
"items": {
"type": "object",
"properties": {
"publicDisplay": {
"type": "boolean",
"description": "Defines if the receivingHistory should be visible to the public."
},
"enumeration": {
"type": "string",
"description": "This is the volume/issue number (e.g. v.71:no.6-2)"
},
"chronology": {
"type": "string",
"description": "Repeated element from Receiving history - Enumeration AND Receiving history - Chronology"
}
}
}
}
}
},
"discoverySuppress": {
"type": "boolean",
"description": "records the fact that the record should not be displayed in a discovery system"
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"type": "string",
"description": "UUID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"uniqueItems": true
},
"holdingsInstance": {
"description": "Holdings Instance",
"type": "object",
"readonly": true,
"folio:isVirtual": true,
"folio:linkBase": "inventory/instances",
"folio:linkFromField": "instanceId",
"folio:linkToField": "id",
"folio:includedElement": "instances.0",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"id": {
"type": "string",
"description": "The system assigned unique ID of the instance record"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"matchKey": {
"type": "string",
"description": "An unique instance identifier matching a client-side bibliographic record identification. Could be an actual local identifier or a key generated from metadata in the local bibliographic record. Enables the client to determine if a client side bibliographic record already exists as an Instance in Inventory"
},
"sourceUri": {
"type": "string",
"description": "A remote URI uniquely identifying the source of the instance"
},
"source": {
"type": "string",
"description": "The metadata source and its format of the underlying record to the instance record. (e.g. FOLIO if it's a record created in Inventory; MARC if it's a MARC record created in MARCcat or EPKB if it's a record coming from eHoldings)"
},
"parentInstances": {
"description": "Array of parent instances",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the parent instance",
"type": "string"
},
"superInstanceId": {
"description": "Id of the super instance",
"type": "string"
},
"instanceRelationshipTypeId": {
"description": "Id of the relationship type",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"superInstanceId",
"instanceRelationshipTypeId"
]
}
},
"childInstances": {
"description": "Child instances",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"subInstanceId": {
"description": "Id of sub Instance",
"type": "string"
},
"instanceRelationshipTypeId": {
"description": "Id of the relationship type",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id",
"subInstanceId",
"instanceRelationshipTypeId"
]
}
},
"title": {
"type": "string",
"description": "The primary title (or label) associated with the resource"
},
"indexTitle": {
"type": "string",
"description": "Title normalized for browsing and searching; based on the title with articles removed"
},
"alternativeTitles": {
"type": "array",
"description": "List of alternative titles for the resource (e.g. original language version title of a movie)",
"items": {
"type": "object",
"properties": {
"alternativeTitleTypeId": {
"type": "string",
"description": "ID for an alternative title qualifier"
},
"alternativeTitle": {
"type": "string",
"description": "An alternative title for the resource"
},
"authorityId": {
"type": "string",
"description": "UUID of authority record that controls an alternative title",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"uniqueItems": true
},
"editions": {
"type": "array",
"description": "The edition statement, imprint and other publication source information",
"items": {
"type": "string"
},
"uniqueItems": true
},
"series": {
"type": "array",
"description": "List of series titles associated with the resource (e.g. Harry Potter)",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Series title value"
},
"authorityId": {
"type": "string",
"description": "UUID of authority record that controls an series title",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"additionalProperties": false,
"required": [
"value"
]
},
"uniqueItems": true
},
"identifiers": {
"type": "array",
"description": "An extensible set of name-value pairs of identifiers associated with the resource",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
}
},
"additionalProperties": false,
"required": [
"value",
"identifierTypeId"
]
}
},
"contributors": {
"type": "array",
"description": "List of contributors",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Personal name, corporate name, meeting name"
},
"contributorTypeId": {
"type": "string",
"description": "ID for the contributor type term defined as a referencetable in settings"
},
"contributorTypeText": {
"type": "string",
"description": "Free text element for adding contributor type terms other that defined by the MARC code list for relators"
},
"contributorNameTypeId": {
"type": "string",
"description": "Contributor type terms defined by the MARC code list for relators"
},
"authorityId": {
"type": "string",
"description": "ID of authority record that controls the contributor",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary contributor"
}
},
"additionalProperties": false,
"required": [
"name",
"contributorNameTypeId"
]
}
},
"subjects": {
"type": "array",
"description": "List of subject headings",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Subject heading value"
},
"authorityId": {
"type": "string",
"description": "UUID of authority record that controls a subject heading",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"sourceId": {
"type": "string",
"description": "UUID of subject source",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"typeId": {
"type": "string",
"description": "UUID of subject type",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"additionalProperties": false,
"required": [
"value"
]
},
"uniqueItems": true
},
"classifications": {
"type": "array",
"description": "List of classifications",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"classificationNumber": {
"type": "string",
"description": "Classification (e.g. classification scheme, classification schedule)"
},
"classificationTypeId": {
"type": "string",
"description": "List of classification schemas (e.g. LC, Canadian Classification, NLM, National Agricultural Library, UDC, and Dewey)"
}
},
"additionalProperties": false,
"required": [
"classificationNumber",
"classificationTypeId"
]
}
},
"publication": {
"type": "array",
"description": "List of publication items",
"items": {
"type": "object",
"properties": {
"publisher": {
"type": "string",
"description": "Name of publisher, distributor, etc."
},
"place": {
"type": "string",
"description": "Place of publication, distribution, etc."
},
"dateOfPublication": {
"type": "string",
"description": "Date (year YYYY) of publication, distribution, etc."
},
"role": {
"type": "string",
"description": "The role of the publisher, distributor, etc."
}
}
}
},
"publicationFrequency": {
"type": "array",
"description": "List of intervals at which a serial appears (e.g. daily, weekly, monthly, quarterly, etc.)",
"items": {
"type": "string"
},
"uniqueItems": true
},
"publicationRange": {
"type": "array",
"description": "The range of sequential designation/chronology of publication, or date range",
"items": {
"type": "string"
},
"uniqueItems": true
},
"electronicAccess": {
"type": "array",
"description": "List of electronic access items",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "The value of the MARC tag field 856 2nd indicator, where the values are: no information provided, resource, version of resource, related resource, no display constant generated"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship between the electronic resource at the location identified and the item described in the record as a whole"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"dates": {
"type": "object",
"description": "Instance Dates",
"properties": {
"dateTypeId": {
"type": "string",
"description": "Date type ID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"date1": {
"type": "string",
"description": "Date 1",
"maxLength": 4
},
"date2": {
"type": "string",
"description": "Date 2",
"maxLength": 4
}
}
},
"instanceTypeId": {
"type": "string",
"description": "The unique term for the resource type whether it's from the RDA content term list of locally defined"
},
"instanceFormatIds": {
"type": "array",
"description": "The unique term for the format whether it's from the RDA carrier term list of locally defined",
"items": {
"type": "string"
}
},
"physicalDescriptions": {
"type": "array",
"description": "Physical description of the described resource, including its extent, dimensions, and such other physical details as a description of any accompanying materials and unit type and size",
"items": {
"type": "string"
}
},
"languages": {
"type": "array",
"description": "The set of languages used by the resource",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"type": "array",
"description": "Bibliographic notes (e.g. general notes, specialized notes), and administrative notes",
"items": {
"type": "object",
"properties": {
"instanceNoteTypeId": {
"description": "ID of the type of note",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"note": {
"type": "string",
"description": "Text content of the note"
},
"staffOnly": {
"type": "boolean",
"description": "If true, determines that the note should not be visible for others than staff",
"default": false
}
}
}
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"modeOfIssuanceId": {
"type": "string",
"description": "RDA mode of issuance is a categorization reflecting whether a resource is issued in one or more parts, the way it is updated, and whether its termination is predetermined or not (e.g. monograph, sequential monograph, serial; integrating Resource, other)"
},
"catalogedDate": {
"type": "string",
"description": "Date or timestamp on an instance for when is was considered cataloged"
},
"previouslyHeld": {
"type": "boolean",
"description": "Records the fact that the resource was previously held by the library for things like Hathi access, etc."
},
"staffSuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed for others than catalogers"
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"deleted": {
"type": "boolean",
"description": "Indicates whether the record was marked for deletion"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"type": "string"
}
},
"sourceRecordFormat": {
"description": "Format of the instance source record, if a source record exists",
"type": "string",
"enum": [
"MARC-JSON"
],
"readonly": true
},
"statusId": {
"type": "string",
"description": "Instance status term (e.g. cataloged, uncatalogued, batch loaded, temporary, other, not yet assigned)"
},
"statusUpdatedDate": {
"type": "string",
"description": "Date [or timestamp] for when the instance status was updated"
},
"tags": {
"description": "arbitrary tags associated with this instance",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"natureOfContentTermIds": {
"type": "array",
"description": "Array of UUID for the Instance nature of content (e.g. bibliography, biography, exhibition catalogue, festschrift, newspaper, proceedings, research report, thesis or website)",
"items": {
"type": "string",
"description": "Single UUID for the Instance nature of content",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"isBoundWith": {
"description": "Indicates if this Instance is included in a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"precedingTitles": {
"description": "Array of preceding titles",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the preceding title",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"precedingInstanceId": {
"description": "Id of the preceding instance id",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"title": {
"type": "string",
"description": "The primary title (or label) associated with the resource"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"identifiers": {
"type": "array",
"description": "An extensible set of name-value pairs of identifiers associated with the resource",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
}
},
"additionalProperties": false,
"required": [
"value",
"identifierTypeId"
]
}
}
},
"additionalProperties": false
}
},
"succeedingTitles": {
"description": "Array of succeeding titles",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the succeeding title",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"succeedingInstanceId": {
"description": "Id of the succeeding instance id",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"title": {
"type": "string",
"description": "The primary title (or label) associated with the resource"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"identifiers": {
"type": "array",
"description": "An extensible set of name-value pairs of identifiers associated with the resource",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
}
},
"additionalProperties": false,
"required": [
"value",
"identifierTypeId"
]
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false,
"required": [
"source",
"title",
"instanceTypeId"
]
},
"tags": {
"description": "arbitrary tags associated with this holding",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"sourceId": {
"description": "UUID of the holdings records source",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
}
},
"additionalProperties": false,
"required": [
"instanceId",
"permanentLocationId"
]
}Example:
{
"id": "0c45bb50-7c9b-48b0-86eb-178a494e25fe",
"_version": 2,
"hrid": "hold000000000002",
"holdingsTypeId": "03c9c400-b9e3-4a07-ac0e-05ab470233ed",
"formerIds": [],
"instanceId": "69640328-788e-43fc-9c3c-af39e243f3b7",
"permanentLocationId": "fcd64ce1-6995-48f0-840e-89ffa2288371",
"effectiveLocationId": "fcd64ce1-6995-48f0-840e-89ffa2288371",
"electronicAccess": [],
"notes": [],
"holdingsStatements": [
{
"statement": "Line 1b"
},
{
"statement": "Line 2b"
}
],
"holdingsStatementsForIndexes": [],
"holdingsStatementsForSupplements": [],
"statisticalCodeIds": [],
"metadata": {
"createdDate": "2021-09-17T09:43:23.885+00:00",
"createdByUserId": "098321d1-b9cd-5f1c-a004-ffa2bac61f90",
"updatedDate": "2021-09-17T09:43:23.885+00:00",
"updatedByUserId": "098321d1-b9cd-5f1c-a004-ffa2bac61f90"
},
"sourceId": "036ee84a-6afd-4c3c-9ad3-4a12ab875f59"
}HTTP status code 204
Holdings successfully updated
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to update Holdings -- malformed JSON at 13:4"
HTTP status code 404
Holdings with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"Holdings not found"
HTTP status code 409
Optimistic locking version conflict
Body
Media type: text/plain
Type: any
Example:
version conflictHTTP status code 422
Validation errors
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorCollection of instance items.
get
Retrieve a list of instance items.
post
Create a new instance item.
delete
get /inventory/instances
Retrieve a list of instance items.
Query Parameters
- offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)
Skip over a number of elements by specifying an offset value for the query
Example:
0 - limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)
Limit the number of elements returned in the response
Example:
10 - query: (string)
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
using CQL (indexes for item and material type)
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode title="uproot*" - lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 200
Returns a list of instance items
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A collection of instance records",
"type": "object",
"properties": {
"instances": {
"description": "List of instance records",
"id": "instances",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An instance record",
"properties": {
"id": {
"type": "string",
"description": "The system assigned unique ID of the instance record"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"matchKey": {
"type": "string",
"description": "An unique instance identifier matching a client-side bibliographic record identification. Could be an actual local identifier or a key generated from metadata in the local bibliographic record. Enables the client to determine if a client side bibliographic record already exists as an Instance in Inventory"
},
"sourceUri": {
"type": "string",
"description": "A remote URI uniquely identifying the source of the instance"
},
"source": {
"type": "string",
"description": "The metadata source and its format of the underlying record to the instance record. (e.g. FOLIO if it's a record created in Inventory; MARC if it's a MARC record created in MARCcat or EPKB if it's a record coming from eHoldings)"
},
"parentInstances": {
"description": "Array of parent instances",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the parent instance",
"type": "string"
},
"superInstanceId": {
"description": "Id of the super instance",
"type": "string"
},
"instanceRelationshipTypeId": {
"description": "Id of the relationship type",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"superInstanceId",
"instanceRelationshipTypeId"
]
}
},
"childInstances": {
"description": "Child instances",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"subInstanceId": {
"description": "Id of sub Instance",
"type": "string"
},
"instanceRelationshipTypeId": {
"description": "Id of the relationship type",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id",
"subInstanceId",
"instanceRelationshipTypeId"
]
}
},
"title": {
"type": "string",
"description": "The primary title (or label) associated with the resource"
},
"indexTitle": {
"type": "string",
"description": "Title normalized for browsing and searching; based on the title with articles removed"
},
"alternativeTitles": {
"type": "array",
"description": "List of alternative titles for the resource (e.g. original language version title of a movie)",
"items": {
"type": "object",
"properties": {
"alternativeTitleTypeId": {
"type": "string",
"description": "ID for an alternative title qualifier"
},
"alternativeTitle": {
"type": "string",
"description": "An alternative title for the resource"
},
"authorityId": {
"type": "string",
"description": "UUID of authority record that controls an alternative title",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"uniqueItems": true
},
"editions": {
"type": "array",
"description": "The edition statement, imprint and other publication source information",
"items": {
"type": "string"
},
"uniqueItems": true
},
"series": {
"type": "array",
"description": "List of series titles associated with the resource (e.g. Harry Potter)",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Series title value"
},
"authorityId": {
"type": "string",
"description": "UUID of authority record that controls an series title",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"additionalProperties": false,
"required": [
"value"
]
},
"uniqueItems": true
},
"identifiers": {
"type": "array",
"description": "An extensible set of name-value pairs of identifiers associated with the resource",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
}
},
"additionalProperties": false,
"required": [
"value",
"identifierTypeId"
]
}
},
"contributors": {
"type": "array",
"description": "List of contributors",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Personal name, corporate name, meeting name"
},
"contributorTypeId": {
"type": "string",
"description": "ID for the contributor type term defined as a referencetable in settings"
},
"contributorTypeText": {
"type": "string",
"description": "Free text element for adding contributor type terms other that defined by the MARC code list for relators"
},
"contributorNameTypeId": {
"type": "string",
"description": "Contributor type terms defined by the MARC code list for relators"
},
"authorityId": {
"type": "string",
"description": "ID of authority record that controls the contributor",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary contributor"
}
},
"additionalProperties": false,
"required": [
"name",
"contributorNameTypeId"
]
}
},
"subjects": {
"type": "array",
"description": "List of subject headings",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Subject heading value"
},
"authorityId": {
"type": "string",
"description": "UUID of authority record that controls a subject heading",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"sourceId": {
"type": "string",
"description": "UUID of subject source",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"typeId": {
"type": "string",
"description": "UUID of subject type",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"additionalProperties": false,
"required": [
"value"
]
},
"uniqueItems": true
},
"classifications": {
"type": "array",
"description": "List of classifications",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"classificationNumber": {
"type": "string",
"description": "Classification (e.g. classification scheme, classification schedule)"
},
"classificationTypeId": {
"type": "string",
"description": "List of classification schemas (e.g. LC, Canadian Classification, NLM, National Agricultural Library, UDC, and Dewey)"
}
},
"additionalProperties": false,
"required": [
"classificationNumber",
"classificationTypeId"
]
}
},
"publication": {
"type": "array",
"description": "List of publication items",
"items": {
"type": "object",
"properties": {
"publisher": {
"type": "string",
"description": "Name of publisher, distributor, etc."
},
"place": {
"type": "string",
"description": "Place of publication, distribution, etc."
},
"dateOfPublication": {
"type": "string",
"description": "Date (year YYYY) of publication, distribution, etc."
},
"role": {
"type": "string",
"description": "The role of the publisher, distributor, etc."
}
}
}
},
"publicationFrequency": {
"type": "array",
"description": "List of intervals at which a serial appears (e.g. daily, weekly, monthly, quarterly, etc.)",
"items": {
"type": "string"
},
"uniqueItems": true
},
"publicationRange": {
"type": "array",
"description": "The range of sequential designation/chronology of publication, or date range",
"items": {
"type": "string"
},
"uniqueItems": true
},
"electronicAccess": {
"type": "array",
"description": "List of electronic access items",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "The value of the MARC tag field 856 2nd indicator, where the values are: no information provided, resource, version of resource, related resource, no display constant generated"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship between the electronic resource at the location identified and the item described in the record as a whole"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"dates": {
"type": "object",
"description": "Instance Dates",
"properties": {
"dateTypeId": {
"type": "string",
"description": "Date type ID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"date1": {
"type": "string",
"description": "Date 1",
"maxLength": 4
},
"date2": {
"type": "string",
"description": "Date 2",
"maxLength": 4
}
}
},
"instanceTypeId": {
"type": "string",
"description": "The unique term for the resource type whether it's from the RDA content term list of locally defined"
},
"instanceFormatIds": {
"type": "array",
"description": "The unique term for the format whether it's from the RDA carrier term list of locally defined",
"items": {
"type": "string"
}
},
"physicalDescriptions": {
"type": "array",
"description": "Physical description of the described resource, including its extent, dimensions, and such other physical details as a description of any accompanying materials and unit type and size",
"items": {
"type": "string"
}
},
"languages": {
"type": "array",
"description": "The set of languages used by the resource",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"type": "array",
"description": "Bibliographic notes (e.g. general notes, specialized notes), and administrative notes",
"items": {
"type": "object",
"properties": {
"instanceNoteTypeId": {
"description": "ID of the type of note",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"note": {
"type": "string",
"description": "Text content of the note"
},
"staffOnly": {
"type": "boolean",
"description": "If true, determines that the note should not be visible for others than staff",
"default": false
}
}
}
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"modeOfIssuanceId": {
"type": "string",
"description": "RDA mode of issuance is a categorization reflecting whether a resource is issued in one or more parts, the way it is updated, and whether its termination is predetermined or not (e.g. monograph, sequential monograph, serial; integrating Resource, other)"
},
"catalogedDate": {
"type": "string",
"description": "Date or timestamp on an instance for when is was considered cataloged"
},
"previouslyHeld": {
"type": "boolean",
"description": "Records the fact that the resource was previously held by the library for things like Hathi access, etc."
},
"staffSuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed for others than catalogers"
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"deleted": {
"type": "boolean",
"description": "Indicates whether the record was marked for deletion"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"type": "string"
}
},
"sourceRecordFormat": {
"description": "Format of the instance source record, if a source record exists",
"type": "string",
"enum": [
"MARC-JSON"
],
"readonly": true
},
"statusId": {
"type": "string",
"description": "Instance status term (e.g. cataloged, uncatalogued, batch loaded, temporary, other, not yet assigned)"
},
"statusUpdatedDate": {
"type": "string",
"description": "Date [or timestamp] for when the instance status was updated"
},
"tags": {
"description": "arbitrary tags associated with this instance",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"natureOfContentTermIds": {
"type": "array",
"description": "Array of UUID for the Instance nature of content (e.g. bibliography, biography, exhibition catalogue, festschrift, newspaper, proceedings, research report, thesis or website)",
"items": {
"type": "string",
"description": "Single UUID for the Instance nature of content",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"isBoundWith": {
"description": "Indicates if this Instance is included in a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"precedingTitles": {
"description": "Array of preceding titles",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the preceding title",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"precedingInstanceId": {
"description": "Id of the preceding instance id",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"title": {
"type": "string",
"description": "The primary title (or label) associated with the resource"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"identifiers": {
"type": "array",
"description": "An extensible set of name-value pairs of identifiers associated with the resource",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
}
},
"additionalProperties": false,
"required": [
"value",
"identifierTypeId"
]
}
}
},
"additionalProperties": false
}
},
"succeedingTitles": {
"description": "Array of succeeding titles",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the succeeding title",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"succeedingInstanceId": {
"description": "Id of the succeeding instance id",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"title": {
"type": "string",
"description": "The primary title (or label) associated with the resource"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"identifiers": {
"type": "array",
"description": "An extensible set of name-value pairs of identifiers associated with the resource",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
}
},
"additionalProperties": false,
"required": [
"value",
"identifierTypeId"
]
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false,
"required": [
"source",
"title",
"instanceTypeId"
]
}
},
"totalRecords": {
"type": "integer"
}
},
"required": [
"instances",
"totalRecords"
]
}Example:
{
"instances": [
{
"id": "cf23adf0-61ba-4887-bf82-956c4aae2260",
"title": "ADVANCING LIBRARY EDUCATION: TECHNOLOGICAL INNOVATION AND INSTRUCTIONAL DESIGN",
"source": "Local",
"instanceTypeId": "abc5dd49-7ede-49cb-84db-6fac770279a8",
"identifiers": [
{
"identifierTypeId": "8261054f-be78-422d-bd51-4ed9f33c3422",
"value": "9781466636897"
}
],
"contributors": [
{
"contributorNameTypeId": "2b94c631-fca9-a892-c730-03ee529ffe2a",
"name": "Samuels, Simon"
}
]
},
{
"id": "ab312025-0642-45a6-8545-aa02aff1ae7c",
"title": "ADVANCING RESEARCH METHODS WITH NEW TECHNOLOGIES.",
"source": "Local",
"instanceTypeId": "abc5dd49-7ede-49cb-84db-6fac770279a8",
"identifiers": [
{
"identifierTypeId": "8261054f-be78-422d-bd51-4ed9f33c3422",
"value": "9781466639195"
}
],
"contributors": [
{
"contributorNameTypeId": "2b94c631-fca9-a892-c730-03ee529ffe2a",
"name": "Jules, Julian"
}
],
"tags" : {
"tagList" : [
"important"
]
}
}
],
"totalRecords": 2
}
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
unable to list instances -- malformed parameter 'query', syntax error at column 6HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to list instances -- unauthorizedHTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorpost /inventory/instances
Create a new instance item.
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An instance record",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The system assigned unique ID of the instance record"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"matchKey": {
"type": "string",
"description": "An unique instance identifier matching a client-side bibliographic record identification. Could be an actual local identifier or a key generated from metadata in the local bibliographic record. Enables the client to determine if a client side bibliographic record already exists as an Instance in Inventory"
},
"sourceUri": {
"type": "string",
"description": "A remote URI uniquely identifying the source of the instance"
},
"source": {
"type": "string",
"description": "The metadata source and its format of the underlying record to the instance record. (e.g. FOLIO if it's a record created in Inventory; MARC if it's a MARC record created in MARCcat or EPKB if it's a record coming from eHoldings)"
},
"parentInstances": {
"description": "Array of parent instances",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the parent instance",
"type": "string"
},
"superInstanceId": {
"description": "Id of the super instance",
"type": "string"
},
"instanceRelationshipTypeId": {
"description": "Id of the relationship type",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"superInstanceId",
"instanceRelationshipTypeId"
]
}
},
"childInstances": {
"description": "Child instances",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"subInstanceId": {
"description": "Id of sub Instance",
"type": "string"
},
"instanceRelationshipTypeId": {
"description": "Id of the relationship type",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id",
"subInstanceId",
"instanceRelationshipTypeId"
]
}
},
"title": {
"type": "string",
"description": "The primary title (or label) associated with the resource"
},
"indexTitle": {
"type": "string",
"description": "Title normalized for browsing and searching; based on the title with articles removed"
},
"alternativeTitles": {
"type": "array",
"description": "List of alternative titles for the resource (e.g. original language version title of a movie)",
"items": {
"type": "object",
"properties": {
"alternativeTitleTypeId": {
"type": "string",
"description": "ID for an alternative title qualifier"
},
"alternativeTitle": {
"type": "string",
"description": "An alternative title for the resource"
},
"authorityId": {
"type": "string",
"description": "UUID of authority record that controls an alternative title",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"uniqueItems": true
},
"editions": {
"type": "array",
"description": "The edition statement, imprint and other publication source information",
"items": {
"type": "string"
},
"uniqueItems": true
},
"series": {
"type": "array",
"description": "List of series titles associated with the resource (e.g. Harry Potter)",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Series title value"
},
"authorityId": {
"type": "string",
"description": "UUID of authority record that controls an series title",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"additionalProperties": false,
"required": [
"value"
]
},
"uniqueItems": true
},
"identifiers": {
"type": "array",
"description": "An extensible set of name-value pairs of identifiers associated with the resource",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
}
},
"additionalProperties": false,
"required": [
"value",
"identifierTypeId"
]
}
},
"contributors": {
"type": "array",
"description": "List of contributors",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Personal name, corporate name, meeting name"
},
"contributorTypeId": {
"type": "string",
"description": "ID for the contributor type term defined as a referencetable in settings"
},
"contributorTypeText": {
"type": "string",
"description": "Free text element for adding contributor type terms other that defined by the MARC code list for relators"
},
"contributorNameTypeId": {
"type": "string",
"description": "Contributor type terms defined by the MARC code list for relators"
},
"authorityId": {
"type": "string",
"description": "ID of authority record that controls the contributor",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary contributor"
}
},
"additionalProperties": false,
"required": [
"name",
"contributorNameTypeId"
]
}
},
"subjects": {
"type": "array",
"description": "List of subject headings",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Subject heading value"
},
"authorityId": {
"type": "string",
"description": "UUID of authority record that controls a subject heading",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"sourceId": {
"type": "string",
"description": "UUID of subject source",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"typeId": {
"type": "string",
"description": "UUID of subject type",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"additionalProperties": false,
"required": [
"value"
]
},
"uniqueItems": true
},
"classifications": {
"type": "array",
"description": "List of classifications",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"classificationNumber": {
"type": "string",
"description": "Classification (e.g. classification scheme, classification schedule)"
},
"classificationTypeId": {
"type": "string",
"description": "List of classification schemas (e.g. LC, Canadian Classification, NLM, National Agricultural Library, UDC, and Dewey)"
}
},
"additionalProperties": false,
"required": [
"classificationNumber",
"classificationTypeId"
]
}
},
"publication": {
"type": "array",
"description": "List of publication items",
"items": {
"type": "object",
"properties": {
"publisher": {
"type": "string",
"description": "Name of publisher, distributor, etc."
},
"place": {
"type": "string",
"description": "Place of publication, distribution, etc."
},
"dateOfPublication": {
"type": "string",
"description": "Date (year YYYY) of publication, distribution, etc."
},
"role": {
"type": "string",
"description": "The role of the publisher, distributor, etc."
}
}
}
},
"publicationFrequency": {
"type": "array",
"description": "List of intervals at which a serial appears (e.g. daily, weekly, monthly, quarterly, etc.)",
"items": {
"type": "string"
},
"uniqueItems": true
},
"publicationRange": {
"type": "array",
"description": "The range of sequential designation/chronology of publication, or date range",
"items": {
"type": "string"
},
"uniqueItems": true
},
"electronicAccess": {
"type": "array",
"description": "List of electronic access items",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "The value of the MARC tag field 856 2nd indicator, where the values are: no information provided, resource, version of resource, related resource, no display constant generated"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship between the electronic resource at the location identified and the item described in the record as a whole"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"dates": {
"type": "object",
"description": "Instance Dates",
"properties": {
"dateTypeId": {
"type": "string",
"description": "Date type ID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"date1": {
"type": "string",
"description": "Date 1",
"maxLength": 4
},
"date2": {
"type": "string",
"description": "Date 2",
"maxLength": 4
}
}
},
"instanceTypeId": {
"type": "string",
"description": "The unique term for the resource type whether it's from the RDA content term list of locally defined"
},
"instanceFormatIds": {
"type": "array",
"description": "The unique term for the format whether it's from the RDA carrier term list of locally defined",
"items": {
"type": "string"
}
},
"physicalDescriptions": {
"type": "array",
"description": "Physical description of the described resource, including its extent, dimensions, and such other physical details as a description of any accompanying materials and unit type and size",
"items": {
"type": "string"
}
},
"languages": {
"type": "array",
"description": "The set of languages used by the resource",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"type": "array",
"description": "Bibliographic notes (e.g. general notes, specialized notes), and administrative notes",
"items": {
"type": "object",
"properties": {
"instanceNoteTypeId": {
"description": "ID of the type of note",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"note": {
"type": "string",
"description": "Text content of the note"
},
"staffOnly": {
"type": "boolean",
"description": "If true, determines that the note should not be visible for others than staff",
"default": false
}
}
}
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"modeOfIssuanceId": {
"type": "string",
"description": "RDA mode of issuance is a categorization reflecting whether a resource is issued in one or more parts, the way it is updated, and whether its termination is predetermined or not (e.g. monograph, sequential monograph, serial; integrating Resource, other)"
},
"catalogedDate": {
"type": "string",
"description": "Date or timestamp on an instance for when is was considered cataloged"
},
"previouslyHeld": {
"type": "boolean",
"description": "Records the fact that the resource was previously held by the library for things like Hathi access, etc."
},
"staffSuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed for others than catalogers"
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"deleted": {
"type": "boolean",
"description": "Indicates whether the record was marked for deletion"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"type": "string"
}
},
"sourceRecordFormat": {
"description": "Format of the instance source record, if a source record exists",
"type": "string",
"enum": [
"MARC-JSON"
],
"readonly": true
},
"statusId": {
"type": "string",
"description": "Instance status term (e.g. cataloged, uncatalogued, batch loaded, temporary, other, not yet assigned)"
},
"statusUpdatedDate": {
"type": "string",
"description": "Date [or timestamp] for when the instance status was updated"
},
"tags": {
"description": "arbitrary tags associated with this instance",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"natureOfContentTermIds": {
"type": "array",
"description": "Array of UUID for the Instance nature of content (e.g. bibliography, biography, exhibition catalogue, festschrift, newspaper, proceedings, research report, thesis or website)",
"items": {
"type": "string",
"description": "Single UUID for the Instance nature of content",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"isBoundWith": {
"description": "Indicates if this Instance is included in a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"precedingTitles": {
"description": "Array of preceding titles",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the preceding title",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"precedingInstanceId": {
"description": "Id of the preceding instance id",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"title": {
"type": "string",
"description": "The primary title (or label) associated with the resource"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"identifiers": {
"type": "array",
"description": "An extensible set of name-value pairs of identifiers associated with the resource",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
}
},
"additionalProperties": false,
"required": [
"value",
"identifierTypeId"
]
}
}
},
"additionalProperties": false
}
},
"succeedingTitles": {
"description": "Array of succeeding titles",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the succeeding title",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"succeedingInstanceId": {
"description": "Id of the succeeding instance id",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"title": {
"type": "string",
"description": "The primary title (or label) associated with the resource"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"identifiers": {
"type": "array",
"description": "An extensible set of name-value pairs of identifiers associated with the resource",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
}
},
"additionalProperties": false,
"required": [
"value",
"identifierTypeId"
]
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false,
"required": [
"source",
"title",
"instanceTypeId"
]
}Example:
{
"id": "cf23adf0-61ba-4887-bf82-956c4aae2260",
"title": "ADVANCING LIBRARY EDUCATION: TECHNOLOGICAL INNOVATION AND INSTRUCTIONAL DESIGN",
"source": "Local",
"instanceTypeId": "abc5dd49-7ede-49cb-84db-6fac770279a8",
"identifiers": [
{
"identifierTypeId": "8261054f-be78-422d-bd51-4ed9f33c3422",
"value": "9781466636897"
}
],
"contributors": [
{
"contributorNameTypeId": "2b94c631-fca9-a892-c730-03ee529ffe2a",
"name": "Samuels, Simon"
}
],
"tags" : {
"tagList" : [
"important"
]
}
}
HTTP status code 201
Returns a newly created item, with server-controlled fields like 'id' populated
Headers
- Location: required(string)
URI to the created instance item
Body
Media type: application/json
Type: any
Example:
{
"id": "cf23adf0-61ba-4887-bf82-956c4aae2260",
"title": "ADVANCING LIBRARY EDUCATION: TECHNOLOGICAL INNOVATION AND INSTRUCTIONAL DESIGN",
"source": "Local",
"instanceTypeId": "abc5dd49-7ede-49cb-84db-6fac770279a8",
"identifiers": [
{
"identifierTypeId": "8261054f-be78-422d-bd51-4ed9f33c3422",
"value": "9781466636897"
}
],
"contributors": [
{
"contributorNameTypeId": "2b94c631-fca9-a892-c730-03ee529ffe2a",
"name": "Samuels, Simon"
}
],
"tags" : {
"tagList" : [
"important"
]
}
}
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to add instance -- malformed JSON at 13:3"
HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to create instances -- unauthorizedHTTP status code 422
Validation errors
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administratordelete /inventory/instances
Query Parameters
- query: (string)
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
CQL to select instances to delete, use cql.allRecords=1 to delete all. Deletes connected marc source records.
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode hrid=="in123-0*" - lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 204
Selected instances deleted
HTTP status code 400
Bad request, e.g. malformed query parameter
Body
Media type: text/plain
Type: any
Example:
query parameter is emptyHTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administratorEntity representing a instance
get
Retrieve instance item with given {instanceId}
put
Update instance item with given {instanceId}
delete
Delete instance item with given {instanceId}
get /inventory/instances/{instanceId}
Retrieve instance item with given {instanceId}
URI Parameters
- instanceId: required(string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 200
Returns item with a given ID
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An instance record",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The system assigned unique ID of the instance record"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"matchKey": {
"type": "string",
"description": "An unique instance identifier matching a client-side bibliographic record identification. Could be an actual local identifier or a key generated from metadata in the local bibliographic record. Enables the client to determine if a client side bibliographic record already exists as an Instance in Inventory"
},
"sourceUri": {
"type": "string",
"description": "A remote URI uniquely identifying the source of the instance"
},
"source": {
"type": "string",
"description": "The metadata source and its format of the underlying record to the instance record. (e.g. FOLIO if it's a record created in Inventory; MARC if it's a MARC record created in MARCcat or EPKB if it's a record coming from eHoldings)"
},
"parentInstances": {
"description": "Array of parent instances",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the parent instance",
"type": "string"
},
"superInstanceId": {
"description": "Id of the super instance",
"type": "string"
},
"instanceRelationshipTypeId": {
"description": "Id of the relationship type",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"superInstanceId",
"instanceRelationshipTypeId"
]
}
},
"childInstances": {
"description": "Child instances",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"subInstanceId": {
"description": "Id of sub Instance",
"type": "string"
},
"instanceRelationshipTypeId": {
"description": "Id of the relationship type",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id",
"subInstanceId",
"instanceRelationshipTypeId"
]
}
},
"title": {
"type": "string",
"description": "The primary title (or label) associated with the resource"
},
"indexTitle": {
"type": "string",
"description": "Title normalized for browsing and searching; based on the title with articles removed"
},
"alternativeTitles": {
"type": "array",
"description": "List of alternative titles for the resource (e.g. original language version title of a movie)",
"items": {
"type": "object",
"properties": {
"alternativeTitleTypeId": {
"type": "string",
"description": "ID for an alternative title qualifier"
},
"alternativeTitle": {
"type": "string",
"description": "An alternative title for the resource"
},
"authorityId": {
"type": "string",
"description": "UUID of authority record that controls an alternative title",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"uniqueItems": true
},
"editions": {
"type": "array",
"description": "The edition statement, imprint and other publication source information",
"items": {
"type": "string"
},
"uniqueItems": true
},
"series": {
"type": "array",
"description": "List of series titles associated with the resource (e.g. Harry Potter)",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Series title value"
},
"authorityId": {
"type": "string",
"description": "UUID of authority record that controls an series title",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"additionalProperties": false,
"required": [
"value"
]
},
"uniqueItems": true
},
"identifiers": {
"type": "array",
"description": "An extensible set of name-value pairs of identifiers associated with the resource",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
}
},
"additionalProperties": false,
"required": [
"value",
"identifierTypeId"
]
}
},
"contributors": {
"type": "array",
"description": "List of contributors",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Personal name, corporate name, meeting name"
},
"contributorTypeId": {
"type": "string",
"description": "ID for the contributor type term defined as a referencetable in settings"
},
"contributorTypeText": {
"type": "string",
"description": "Free text element for adding contributor type terms other that defined by the MARC code list for relators"
},
"contributorNameTypeId": {
"type": "string",
"description": "Contributor type terms defined by the MARC code list for relators"
},
"authorityId": {
"type": "string",
"description": "ID of authority record that controls the contributor",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary contributor"
}
},
"additionalProperties": false,
"required": [
"name",
"contributorNameTypeId"
]
}
},
"subjects": {
"type": "array",
"description": "List of subject headings",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Subject heading value"
},
"authorityId": {
"type": "string",
"description": "UUID of authority record that controls a subject heading",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"sourceId": {
"type": "string",
"description": "UUID of subject source",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"typeId": {
"type": "string",
"description": "UUID of subject type",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"additionalProperties": false,
"required": [
"value"
]
},
"uniqueItems": true
},
"classifications": {
"type": "array",
"description": "List of classifications",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"classificationNumber": {
"type": "string",
"description": "Classification (e.g. classification scheme, classification schedule)"
},
"classificationTypeId": {
"type": "string",
"description": "List of classification schemas (e.g. LC, Canadian Classification, NLM, National Agricultural Library, UDC, and Dewey)"
}
},
"additionalProperties": false,
"required": [
"classificationNumber",
"classificationTypeId"
]
}
},
"publication": {
"type": "array",
"description": "List of publication items",
"items": {
"type": "object",
"properties": {
"publisher": {
"type": "string",
"description": "Name of publisher, distributor, etc."
},
"place": {
"type": "string",
"description": "Place of publication, distribution, etc."
},
"dateOfPublication": {
"type": "string",
"description": "Date (year YYYY) of publication, distribution, etc."
},
"role": {
"type": "string",
"description": "The role of the publisher, distributor, etc."
}
}
}
},
"publicationFrequency": {
"type": "array",
"description": "List of intervals at which a serial appears (e.g. daily, weekly, monthly, quarterly, etc.)",
"items": {
"type": "string"
},
"uniqueItems": true
},
"publicationRange": {
"type": "array",
"description": "The range of sequential designation/chronology of publication, or date range",
"items": {
"type": "string"
},
"uniqueItems": true
},
"electronicAccess": {
"type": "array",
"description": "List of electronic access items",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "The value of the MARC tag field 856 2nd indicator, where the values are: no information provided, resource, version of resource, related resource, no display constant generated"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship between the electronic resource at the location identified and the item described in the record as a whole"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"dates": {
"type": "object",
"description": "Instance Dates",
"properties": {
"dateTypeId": {
"type": "string",
"description": "Date type ID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"date1": {
"type": "string",
"description": "Date 1",
"maxLength": 4
},
"date2": {
"type": "string",
"description": "Date 2",
"maxLength": 4
}
}
},
"instanceTypeId": {
"type": "string",
"description": "The unique term for the resource type whether it's from the RDA content term list of locally defined"
},
"instanceFormatIds": {
"type": "array",
"description": "The unique term for the format whether it's from the RDA carrier term list of locally defined",
"items": {
"type": "string"
}
},
"physicalDescriptions": {
"type": "array",
"description": "Physical description of the described resource, including its extent, dimensions, and such other physical details as a description of any accompanying materials and unit type and size",
"items": {
"type": "string"
}
},
"languages": {
"type": "array",
"description": "The set of languages used by the resource",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"type": "array",
"description": "Bibliographic notes (e.g. general notes, specialized notes), and administrative notes",
"items": {
"type": "object",
"properties": {
"instanceNoteTypeId": {
"description": "ID of the type of note",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"note": {
"type": "string",
"description": "Text content of the note"
},
"staffOnly": {
"type": "boolean",
"description": "If true, determines that the note should not be visible for others than staff",
"default": false
}
}
}
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"modeOfIssuanceId": {
"type": "string",
"description": "RDA mode of issuance is a categorization reflecting whether a resource is issued in one or more parts, the way it is updated, and whether its termination is predetermined or not (e.g. monograph, sequential monograph, serial; integrating Resource, other)"
},
"catalogedDate": {
"type": "string",
"description": "Date or timestamp on an instance for when is was considered cataloged"
},
"previouslyHeld": {
"type": "boolean",
"description": "Records the fact that the resource was previously held by the library for things like Hathi access, etc."
},
"staffSuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed for others than catalogers"
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"deleted": {
"type": "boolean",
"description": "Indicates whether the record was marked for deletion"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"type": "string"
}
},
"sourceRecordFormat": {
"description": "Format of the instance source record, if a source record exists",
"type": "string",
"enum": [
"MARC-JSON"
],
"readonly": true
},
"statusId": {
"type": "string",
"description": "Instance status term (e.g. cataloged, uncatalogued, batch loaded, temporary, other, not yet assigned)"
},
"statusUpdatedDate": {
"type": "string",
"description": "Date [or timestamp] for when the instance status was updated"
},
"tags": {
"description": "arbitrary tags associated with this instance",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"natureOfContentTermIds": {
"type": "array",
"description": "Array of UUID for the Instance nature of content (e.g. bibliography, biography, exhibition catalogue, festschrift, newspaper, proceedings, research report, thesis or website)",
"items": {
"type": "string",
"description": "Single UUID for the Instance nature of content",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"isBoundWith": {
"description": "Indicates if this Instance is included in a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"precedingTitles": {
"description": "Array of preceding titles",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the preceding title",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"precedingInstanceId": {
"description": "Id of the preceding instance id",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"title": {
"type": "string",
"description": "The primary title (or label) associated with the resource"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"identifiers": {
"type": "array",
"description": "An extensible set of name-value pairs of identifiers associated with the resource",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
}
},
"additionalProperties": false,
"required": [
"value",
"identifierTypeId"
]
}
}
},
"additionalProperties": false
}
},
"succeedingTitles": {
"description": "Array of succeeding titles",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the succeeding title",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"succeedingInstanceId": {
"description": "Id of the succeeding instance id",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"title": {
"type": "string",
"description": "The primary title (or label) associated with the resource"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"identifiers": {
"type": "array",
"description": "An extensible set of name-value pairs of identifiers associated with the resource",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
}
},
"additionalProperties": false,
"required": [
"value",
"identifierTypeId"
]
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false,
"required": [
"source",
"title",
"instanceTypeId"
]
}Example:
{
"id": "cf23adf0-61ba-4887-bf82-956c4aae2260",
"title": "ADVANCING LIBRARY EDUCATION: TECHNOLOGICAL INNOVATION AND INSTRUCTIONAL DESIGN",
"source": "Local",
"instanceTypeId": "abc5dd49-7ede-49cb-84db-6fac770279a8",
"identifiers": [
{
"identifierTypeId": "8261054f-be78-422d-bd51-4ed9f33c3422",
"value": "9781466636897"
}
],
"contributors": [
{
"contributorNameTypeId": "2b94c631-fca9-a892-c730-03ee529ffe2a",
"name": "Samuels, Simon"
}
],
"tags" : {
"tagList" : [
"important"
]
}
}
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"instance not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorput /inventory/instances/{instanceId}
Update instance item with given {instanceId}
URI Parameters
- instanceId: required(string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An instance record",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The system assigned unique ID of the instance record"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"matchKey": {
"type": "string",
"description": "An unique instance identifier matching a client-side bibliographic record identification. Could be an actual local identifier or a key generated from metadata in the local bibliographic record. Enables the client to determine if a client side bibliographic record already exists as an Instance in Inventory"
},
"sourceUri": {
"type": "string",
"description": "A remote URI uniquely identifying the source of the instance"
},
"source": {
"type": "string",
"description": "The metadata source and its format of the underlying record to the instance record. (e.g. FOLIO if it's a record created in Inventory; MARC if it's a MARC record created in MARCcat or EPKB if it's a record coming from eHoldings)"
},
"parentInstances": {
"description": "Array of parent instances",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the parent instance",
"type": "string"
},
"superInstanceId": {
"description": "Id of the super instance",
"type": "string"
},
"instanceRelationshipTypeId": {
"description": "Id of the relationship type",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"superInstanceId",
"instanceRelationshipTypeId"
]
}
},
"childInstances": {
"description": "Child instances",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"subInstanceId": {
"description": "Id of sub Instance",
"type": "string"
},
"instanceRelationshipTypeId": {
"description": "Id of the relationship type",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"id",
"subInstanceId",
"instanceRelationshipTypeId"
]
}
},
"title": {
"type": "string",
"description": "The primary title (or label) associated with the resource"
},
"indexTitle": {
"type": "string",
"description": "Title normalized for browsing and searching; based on the title with articles removed"
},
"alternativeTitles": {
"type": "array",
"description": "List of alternative titles for the resource (e.g. original language version title of a movie)",
"items": {
"type": "object",
"properties": {
"alternativeTitleTypeId": {
"type": "string",
"description": "ID for an alternative title qualifier"
},
"alternativeTitle": {
"type": "string",
"description": "An alternative title for the resource"
},
"authorityId": {
"type": "string",
"description": "UUID of authority record that controls an alternative title",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
}
},
"uniqueItems": true
},
"editions": {
"type": "array",
"description": "The edition statement, imprint and other publication source information",
"items": {
"type": "string"
},
"uniqueItems": true
},
"series": {
"type": "array",
"description": "List of series titles associated with the resource (e.g. Harry Potter)",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Series title value"
},
"authorityId": {
"type": "string",
"description": "UUID of authority record that controls an series title",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"additionalProperties": false,
"required": [
"value"
]
},
"uniqueItems": true
},
"identifiers": {
"type": "array",
"description": "An extensible set of name-value pairs of identifiers associated with the resource",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
}
},
"additionalProperties": false,
"required": [
"value",
"identifierTypeId"
]
}
},
"contributors": {
"type": "array",
"description": "List of contributors",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Personal name, corporate name, meeting name"
},
"contributorTypeId": {
"type": "string",
"description": "ID for the contributor type term defined as a referencetable in settings"
},
"contributorTypeText": {
"type": "string",
"description": "Free text element for adding contributor type terms other that defined by the MARC code list for relators"
},
"contributorNameTypeId": {
"type": "string",
"description": "Contributor type terms defined by the MARC code list for relators"
},
"authorityId": {
"type": "string",
"description": "ID of authority record that controls the contributor",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"primary": {
"type": "boolean",
"description": "Whether this is the primary contributor"
}
},
"additionalProperties": false,
"required": [
"name",
"contributorNameTypeId"
]
}
},
"subjects": {
"type": "array",
"description": "List of subject headings",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Subject heading value"
},
"authorityId": {
"type": "string",
"description": "UUID of authority record that controls a subject heading",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"sourceId": {
"type": "string",
"description": "UUID of subject source",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"typeId": {
"type": "string",
"description": "UUID of subject type",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"additionalProperties": false,
"required": [
"value"
]
},
"uniqueItems": true
},
"classifications": {
"type": "array",
"description": "List of classifications",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"classificationNumber": {
"type": "string",
"description": "Classification (e.g. classification scheme, classification schedule)"
},
"classificationTypeId": {
"type": "string",
"description": "List of classification schemas (e.g. LC, Canadian Classification, NLM, National Agricultural Library, UDC, and Dewey)"
}
},
"additionalProperties": false,
"required": [
"classificationNumber",
"classificationTypeId"
]
}
},
"publication": {
"type": "array",
"description": "List of publication items",
"items": {
"type": "object",
"properties": {
"publisher": {
"type": "string",
"description": "Name of publisher, distributor, etc."
},
"place": {
"type": "string",
"description": "Place of publication, distribution, etc."
},
"dateOfPublication": {
"type": "string",
"description": "Date (year YYYY) of publication, distribution, etc."
},
"role": {
"type": "string",
"description": "The role of the publisher, distributor, etc."
}
}
}
},
"publicationFrequency": {
"type": "array",
"description": "List of intervals at which a serial appears (e.g. daily, weekly, monthly, quarterly, etc.)",
"items": {
"type": "string"
},
"uniqueItems": true
},
"publicationRange": {
"type": "array",
"description": "The range of sequential designation/chronology of publication, or date range",
"items": {
"type": "string"
},
"uniqueItems": true
},
"electronicAccess": {
"type": "array",
"description": "List of electronic access items",
"items": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Uniform Resource Identifier (URI) is a string of characters designed for unambiguous identification of resources"
},
"linkText": {
"type": "string",
"description": "The value of the MARC tag field 856 2nd indicator, where the values are: no information provided, resource, version of resource, related resource, no display constant generated"
},
"materialsSpecification": {
"type": "string",
"description": "Materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
},
"publicNote": {
"type": "string",
"description": "URL public note to be displayed in the discovery"
},
"relationshipId": {
"type": "string",
"description": "Relationship between the electronic resource at the location identified and the item described in the record as a whole"
}
},
"additionalProperties": false,
"required": [
"uri"
]
}
},
"dates": {
"type": "object",
"description": "Instance Dates",
"properties": {
"dateTypeId": {
"type": "string",
"description": "Date type ID",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"date1": {
"type": "string",
"description": "Date 1",
"maxLength": 4
},
"date2": {
"type": "string",
"description": "Date 2",
"maxLength": 4
}
}
},
"instanceTypeId": {
"type": "string",
"description": "The unique term for the resource type whether it's from the RDA content term list of locally defined"
},
"instanceFormatIds": {
"type": "array",
"description": "The unique term for the format whether it's from the RDA carrier term list of locally defined",
"items": {
"type": "string"
}
},
"physicalDescriptions": {
"type": "array",
"description": "Physical description of the described resource, including its extent, dimensions, and such other physical details as a description of any accompanying materials and unit type and size",
"items": {
"type": "string"
}
},
"languages": {
"type": "array",
"description": "The set of languages used by the resource",
"minItems": 0,
"items": {
"type": "string"
}
},
"notes": {
"type": "array",
"description": "Bibliographic notes (e.g. general notes, specialized notes), and administrative notes",
"items": {
"type": "object",
"properties": {
"instanceNoteTypeId": {
"description": "ID of the type of note",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"note": {
"type": "string",
"description": "Text content of the note"
},
"staffOnly": {
"type": "boolean",
"description": "If true, determines that the note should not be visible for others than staff",
"default": false
}
}
}
},
"administrativeNotes": {
"type": "array",
"description": "Administrative notes",
"minItems": 0,
"items": {
"type": "string"
}
},
"modeOfIssuanceId": {
"type": "string",
"description": "RDA mode of issuance is a categorization reflecting whether a resource is issued in one or more parts, the way it is updated, and whether its termination is predetermined or not (e.g. monograph, sequential monograph, serial; integrating Resource, other)"
},
"catalogedDate": {
"type": "string",
"description": "Date or timestamp on an instance for when is was considered cataloged"
},
"previouslyHeld": {
"type": "boolean",
"description": "Records the fact that the resource was previously held by the library for things like Hathi access, etc."
},
"staffSuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed for others than catalogers"
},
"discoverySuppress": {
"type": "boolean",
"description": "Records the fact that the record should not be displayed in a discovery system"
},
"deleted": {
"type": "boolean",
"description": "Indicates whether the record was marked for deletion"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"type": "string"
}
},
"sourceRecordFormat": {
"description": "Format of the instance source record, if a source record exists",
"type": "string",
"enum": [
"MARC-JSON"
],
"readonly": true
},
"statusId": {
"type": "string",
"description": "Instance status term (e.g. cataloged, uncatalogued, batch loaded, temporary, other, not yet assigned)"
},
"statusUpdatedDate": {
"type": "string",
"description": "Date [or timestamp] for when the instance status was updated"
},
"tags": {
"description": "arbitrary tags associated with this instance",
"id": "tags",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Metadata Schema",
"description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"natureOfContentTermIds": {
"type": "array",
"description": "Array of UUID for the Instance nature of content (e.g. bibliography, biography, exhibition catalogue, festschrift, newspaper, proceedings, research report, thesis or website)",
"items": {
"type": "string",
"description": "Single UUID for the Instance nature of content",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
}
},
"isBoundWith": {
"description": "Indicates if this Instance is included in a bound-with",
"type": "boolean",
"default": false,
"readonly": true
},
"precedingTitles": {
"description": "Array of preceding titles",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the preceding title",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"precedingInstanceId": {
"description": "Id of the preceding instance id",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"title": {
"type": "string",
"description": "The primary title (or label) associated with the resource"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"identifiers": {
"type": "array",
"description": "An extensible set of name-value pairs of identifiers associated with the resource",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
}
},
"additionalProperties": false,
"required": [
"value",
"identifierTypeId"
]
}
}
},
"additionalProperties": false
}
},
"succeedingTitles": {
"description": "Array of succeeding titles",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Id of the succeeding title",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"succeedingInstanceId": {
"description": "Id of the succeeding instance id",
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
},
"title": {
"type": "string",
"description": "The primary title (or label) associated with the resource"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"identifiers": {
"type": "array",
"description": "An extensible set of name-value pairs of identifiers associated with the resource",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Resource identifier value"
},
"identifierTypeId": {
"type": "string",
"description": "Resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)"
}
},
"additionalProperties": false,
"required": [
"value",
"identifierTypeId"
]
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false,
"required": [
"source",
"title",
"instanceTypeId"
]
}Example:
{
"id": "cf23adf0-61ba-4887-bf82-956c4aae2260",
"title": "ADVANCING LIBRARY EDUCATION: TECHNOLOGICAL INNOVATION AND INSTRUCTIONAL DESIGN",
"source": "Local",
"instanceTypeId": "abc5dd49-7ede-49cb-84db-6fac770279a8",
"identifiers": [
{
"identifierTypeId": "8261054f-be78-422d-bd51-4ed9f33c3422",
"value": "9781466636897"
}
],
"contributors": [
{
"contributorNameTypeId": "2b94c631-fca9-a892-c730-03ee529ffe2a",
"name": "Samuels, Simon"
}
],
"tags" : {
"tagList" : [
"important"
]
}
}
HTTP status code 204
Item successfully updated
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to update instance -- malformed JSON at 13:4"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"instance not found"
HTTP status code 422
Validation errors
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratordelete /inventory/instances/{instanceId}
Delete instance item with given {instanceId}
URI Parameters
- instanceId: required(string)
Query Parameters
- lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]
HTTP status code 204
Item deleted successfully
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to delete instance -- constraint violation"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"instance not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administratordelete
Toggle the suppression state of an instance record, affecting either instance and associated MARC record if present.
delete /inventory/instances/{instanceId}/mark-deleted
Toggle the suppression state of an instance record, affecting either instance and associated MARC record if present.
URI Parameters
- instanceId: required(string)
HTTP status code 204
Instance marked as deleted.
HTTP status code 404
Instance not found
Body
Media type: text/plain
Type: any
Example:
Instance with such id not foundHTTP status code 422
Validation error
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"type": "object",
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server error