http://localhost
Provides various schemes for creating, updating and deleting instances, holdings records and items in Inventory storage
PUT /inventory-upsert-hridMedia type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "An instance record and an array of holdings records with embedded items",
"type": "object",
"properties": {
"instance": {
"type": "object",
"description": "The Instance, the bibliographic part, of this Inventory record set",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"id": {
"type": "string",
"description": "The system assigned unique ID of the instance record; UUID"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"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)"
},
"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"
},
"matchKey": {
"anyOf": [
{
"type": "string",
"description": "A finished match key string"
},
{
"type": "object",
"description": "A number of properties from which to construct a match key"
}
],
"description": "Optional field for supplying the desire match key for identifying matching Instances. Is removed before passing the Instance object on to FOLIO Inventory."
},
"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"
}
}
},
"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": "string"
},
"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"
},
"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": "string"
},
"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"
]
}
},
"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
}
}
}
},
"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"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"type": "string"
},
"uniqueItems": true
},
"sourceRecordFormat": {
"type": "string",
"description": "Format of the instance source record, if a source record exists (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)",
"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"
}
},
"additionalProperties": false,
"required": [
"source",
"title",
"instanceTypeId",
"hrid"
]
},
"holdingsRecords": {
"type": "array",
"description": "Collection of holdings of the Instance, each holdings record with embedded items",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A holdings record",
"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}$"
},
"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": {
"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}$"
},
"electronicAccess": {
"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"
]
}
},
"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": {
"type": "string",
"description": "Format of holdings record acquisition"
},
"acquisitionMethod": {
"type": "string",
"description": "Method of holdings record acquisition"
},
"receiptStatus": {
"type": "string",
"description": "Receipt status (e.g. pending, awaiting receipt, partially received, fully received, receipt not required, and cancelled)"
},
"notes": {
"type": "array",
"description": "Notes about action, copy, binding etc.",
"items": {
"type": "object",
"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": {
"type": "string"
},
"holdingsStatements": {
"type": "array",
"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"
}
}
}
},
"holdingsStatementsForIndexes": {
"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"
}
}
}
},
"holdingsStatementsForSupplements": {
"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"
}
}
}
},
"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": {
"type": "object",
"properties": {
"displayType": {
"type": "string",
"description": "Display hint. 1: Display fields separately. 2: Display fields concatenated"
},
"entries": {
"type": "array",
"description": ".",
"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"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"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}$"
},
"uniqueItems": true
},
"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"
]
},
"items": {
"type": "array",
"items": {
"description": "Inventory items for this holdings record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the item record"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"type": "string",
"description": "ID of the holdings record the item is a member of."
},
"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"
},
"accessionNumber": {
"type": "string",
"description": "Also called inventar number"
},
"barcode": {
"type": "string",
"description": "Unique inventory control number for physical resources, used largely for circulation purposes"
},
"itemLevelCallNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item, usually printed on a label attached to the item. The call number is used to determine the items physical position in a shelving sequence, e.g. K1 .M44. The Item level call number, is the call number on item level."
},
"itemLevelCallNumberPrefix": {
"type": "string",
"description": "Prefix of the call number on the item level."
},
"itemLevelCallNumberSuffix": {
"type": "string",
"description": "Suffix of the call number on the item level."
},
"itemLevelCallNumberTypeId": {
"type": "string",
"description": "Identifies the source of the call number, e.g., LCC, Dewey, NLM, etc."
},
"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 of the item, if available, otherwise that of the 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}$"
}
},
"additionalProperties": false
},
"volume": {
"type": "string",
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of George Bernard Shaw in three volumes)."
},
"enumeration": {
"type": "string",
"description": "Enumeration is the descriptive information for the numbering scheme of a serial."
},
"chronology": {
"type": "string",
"description": "Chronology is the descriptive information for the dating scheme of a serial."
},
"yearCaption": {
"type": "array",
"description": "In multipart monographs, a caption is a character(s) used to label a level of chronology, e.g., year 1985.",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"type": "string",
"description": "Item identifier number, e.g. imported from the union catalogue (read only)."
},
"copyNumber": {
"type": "string",
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; one copy of a multi-volume, (e.g. Copy 1, or C.7.)"
},
"numberOfPieces": {
"type": "string",
"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)."
},
"descriptionOfPieces": {
"description": "Description of item pieces.",
"type": "string"
},
"numberOfMissingPieces": {
"type": "string",
"description": "Number of missing pieces."
},
"missingPieces": {
"type": "string",
"description": "Description of the missing pieces. "
},
"missingPiecesDate": {
"type": "string",
"description": "Date when the piece(s) went missing."
},
"itemDamagedStatusId": {
"description": "Item dame status id identifier.",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date and time when the item was damaged.",
"type": "string"
},
"notes": {
"type": "array",
"description": "Notes about action, copy, binding etc.",
"items": {
"type": "object",
"properties": {
"itemNoteTypeId": {
"type": "string",
"description": "ID of the type of note"
},
"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
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the circulation note"
},
"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"
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting. Points to /users/{id} resource.",
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note. The user information is generated by the server and needed to support sorting. Points to /users/{id} resource."
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"properties": {
"lastName": {
"description": "The user's last name",
"type": "string"
},
"firstName": {
"description": "The user's first name",
"type": "string"
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting."
},
"staffOnly": {
"type": "boolean",
"description": "Flag to restrict display of this note",
"default": false
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the status e.g. Available, Checked out, In transit",
"type": "string",
"enum": [
"Available",
"Awaiting pickup",
"Awaiting delivery",
"Checked out",
"In process",
"In transit",
"Missing",
"On order",
"Paged",
"Declared lost",
"Order closed",
"Claimed returned"
]
},
"date": {
"description": "Date and time when the status was last changed",
"type": "string",
"format": "date-time",
"readonly": true
}
},
"required": [
"name"
],
"additionalProperties": false
},
"materialTypeId": {
"type": "string",
"description": "Material type, term. Define what type of thing the item is."
},
"permanentLoanTypeId": {
"type": "string",
"description": "The permanent loan type, is the default loan type for a given item. Loan types are tenant-defined."
},
"temporaryLoanTypeId": {
"type": "string",
"description": "Temporary loan type, is the temporary loan type for a given item."
},
"permanentLocationId": {
"type": "string",
"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."
},
"temporaryLocationId": {
"type": "string",
"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."
},
"effectiveLocationId": {
"type": "string",
"description": "Read only current home location for 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}$"
},
"electronicAccess": {
"type": "array",
"description": "References for accessing the item by URL.",
"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"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"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}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"tags": {
"description": "arbitrary tags associated with this item",
"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"
]
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last scanned in the Inventory app.",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time"
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"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",
"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": [
"materialTypeId",
"permanentLoanTypeId",
"holdingsRecordId",
"status",
"hrid"
]
}
}
},
"additionalProperties": false,
"required": [
"permanentLocationId",
"hrid"
]
}
},
"instanceRelations": {
"description": "Object holding information of different types of Instance-to-Instance relationships to create",
"properties": {
"parentInstances": {
"type": "array",
"description": "Collection of objects with information required for finding and linking to parent Instances",
"items": {
"type": "object",
"properties": {
"instanceIdentifier": {
"type": "object",
"description": "Object with information required for finding the parent Instance to link to",
"properties": {
"hrid": {
"type": "string",
"description": "A unique ID for the parent instance to link to"
}
}
},
"provisionalInstance": {
"type": "object",
"description": "Object with at least the mandatory Instance properties required for creating a provisional Instance if the parent does not yet exist. Other valid Instance properties allowed.",
"properties": {
"title": {
"type": "string",
"description": "The parent record’s title"
},
"source": {
"type": "string",
"description": "The parent record’s source"
},
"instanceTypeId": {
"type": "string",
"description": "The parent record’s resource type ID (UUID) "
}
},
"required": [
"title",
"source",
"instanceTypeId"
]
},
"instancesRelationshipTypeId": {
"type": "string",
"description": "UUID for the type of relationship to establish to a parent instance (article, volume, multipart, series)"
}
},
"required": [
"instanceIdentifier",
"instanceRelationshipTypeId"
]
}
},
"childInstances": {
"type": "array",
"description": "Collection of objects with information required for finding and linking to child Instances",
"items": {
"type": "object",
"properties": {
"instanceIdentifier": {
"type": "object",
"description": "Object with information required for finding the child Instance to link to",
"properties": {
"hrid": {
"type": "string",
"description": "A unique ID for the child instance to link to"
}
},
"provisionalInstance": {
"type": "object",
"description": "Object with at least the mandatory Instance properties required for creating a provisional Instance if the child does not yet exist. Other valid Instance properties allowed.",
"properties": {
"title": {
"type": "string",
"description": "The child record’s title"
},
"source": {
"type": "string",
"description": "The child record’s source"
},
"instanceTypeId": {
"type": "string",
"description": "The child record’s resource type ID (UUID) "
}
},
"required": [
"title",
"source",
"instanceTypeId"
]
},
"instancesRelationshipTypeId": {
"type": "string",
"description": "UUID for the type of relationship to establish to a child instance (article, volume, multipart, series)"
}
}
}
}
},
"precedingTitles": {
"type": "array",
"description": "Collection of objects with information required for finding and linking to preceding Instances",
"items": {
"type": "object",
"properties": {
"instanceIdentifier": {
"type": "object",
"description": "Object with information required for finding the preceding Instance to link to",
"properties": {
"hrid": {
"type": "string",
"description": "A unique ID for the preceding instance to link to"
}
},
"provisionalInstance": {
"type": "object",
"description": "Object with at least the mandatory Instance properties required for creating a provisional Instance if the preceding does not yet exist. Other valid Instance properties allowed.",
"properties": {
"title": {
"type": "string",
"description": "The preceding Instance’s title"
},
"source": {
"type": "string",
"description": "The preceding Instance’s source"
},
"instanceTypeId": {
"type": "string",
"description": "The preceding Instance’s resource type ID (UUID) "
}
},
"required": [
"title",
"source",
"instanceTypeId"
]
}
}
}
}
},
"succeedingTitles": {
"type": "array",
"description": "Collection of objects with information required for finding and linking to succeeding Instances",
"items": {
"type": "object",
"properties": {
"instanceIdentifier": {
"type": "object",
"description": "Object with information required for finding the succeeding Instance to link to",
"properties": {
"hrid": {
"type": "string",
"description": "A unique ID for the succeeding instance to link to"
}
},
"provisionalInstance": {
"type": "object",
"description": "Object with at least the mandatory Instance properties required for creating a provisional Instance if the succeeding does not yet exist. Other valid Instance properties allowed.",
"properties": {
"title": {
"type": "string",
"description": "The succeeding Instance’s title"
},
"source": {
"type": "string",
"description": "The succeeding Instance’s source"
},
"instanceTypeId": {
"type": "string",
"description": "The succeeding Instance’s resource type ID (UUID) "
}
},
"required": [
"title",
"source",
"instanceTypeId"
]
}
}
}
}
}
}
}
},
"required": [
"instance",
"holdingsRecords"
]
}Inventory recordset successfully created or updated by HRIDs
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Response on a successful upsert request",
"type": "object",
"properties": {
"instance": {
"type": "object",
"description": "The Instance, the bibliographic part, of this Inventory record set as it was pushed to Inventory storage",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"id": {
"type": "string",
"description": "The system assigned unique ID of the instance record; UUID"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"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)"
},
"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"
},
"matchKey": {
"anyOf": [
{
"type": "string",
"description": "A finished match key string"
},
{
"type": "object",
"description": "A number of properties from which to construct a match key"
}
],
"description": "Optional field for supplying the desire match key for identifying matching Instances. Is removed before passing the Instance object on to FOLIO Inventory."
},
"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"
}
}
},
"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": "string"
},
"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"
},
"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": "string"
},
"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"
]
}
},
"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
}
}
}
},
"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"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"type": "string"
},
"uniqueItems": true
},
"sourceRecordFormat": {
"type": "string",
"description": "Format of the instance source record, if a source record exists (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)",
"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"
}
},
"additionalProperties": false,
"required": [
"source",
"title",
"instanceTypeId"
]
},
"holdingsRecords": {
"type": "array",
"description": "Collection of holdings of the Instance, each holdings record with embedded items as it was pushed to Inventory storage",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A holdings record",
"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}$"
},
"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": {
"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}$"
},
"electronicAccess": {
"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"
]
}
},
"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": {
"type": "string",
"description": "Format of holdings record acquisition"
},
"acquisitionMethod": {
"type": "string",
"description": "Method of holdings record acquisition"
},
"receiptStatus": {
"type": "string",
"description": "Receipt status (e.g. pending, awaiting receipt, partially received, fully received, receipt not required, and cancelled)"
},
"notes": {
"type": "array",
"description": "Notes about action, copy, binding etc.",
"items": {
"type": "object",
"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": {
"type": "string"
},
"holdingsStatements": {
"type": "array",
"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"
}
}
}
},
"holdingsStatementsForIndexes": {
"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"
}
}
}
},
"holdingsStatementsForSupplements": {
"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"
}
}
}
},
"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": {
"type": "object",
"properties": {
"displayType": {
"type": "string",
"description": "Display hint. 1: Display fields separately. 2: Display fields concatenated"
},
"entries": {
"type": "array",
"description": ".",
"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"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"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}$"
},
"uniqueItems": true
},
"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"
]
},
"items": {
"type": "array",
"items": {
"description": "Inventory items for this holdings record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the item record"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"type": "string",
"description": "ID of the holdings record the item is a member of."
},
"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"
},
"accessionNumber": {
"type": "string",
"description": "Also called inventar number"
},
"barcode": {
"type": "string",
"description": "Unique inventory control number for physical resources, used largely for circulation purposes"
},
"itemLevelCallNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item, usually printed on a label attached to the item. The call number is used to determine the items physical position in a shelving sequence, e.g. K1 .M44. The Item level call number, is the call number on item level."
},
"itemLevelCallNumberPrefix": {
"type": "string",
"description": "Prefix of the call number on the item level."
},
"itemLevelCallNumberSuffix": {
"type": "string",
"description": "Suffix of the call number on the item level."
},
"itemLevelCallNumberTypeId": {
"type": "string",
"description": "Identifies the source of the call number, e.g., LCC, Dewey, NLM, etc."
},
"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 of the item, if available, otherwise that of the 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}$"
}
},
"additionalProperties": false
},
"volume": {
"type": "string",
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of George Bernard Shaw in three volumes)."
},
"enumeration": {
"type": "string",
"description": "Enumeration is the descriptive information for the numbering scheme of a serial."
},
"chronology": {
"type": "string",
"description": "Chronology is the descriptive information for the dating scheme of a serial."
},
"yearCaption": {
"type": "array",
"description": "In multipart monographs, a caption is a character(s) used to label a level of chronology, e.g., year 1985.",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"type": "string",
"description": "Item identifier number, e.g. imported from the union catalogue (read only)."
},
"copyNumber": {
"type": "string",
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; one copy of a multi-volume, (e.g. Copy 1, or C.7.)"
},
"numberOfPieces": {
"type": "string",
"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)."
},
"descriptionOfPieces": {
"description": "Description of item pieces.",
"type": "string"
},
"numberOfMissingPieces": {
"type": "string",
"description": "Number of missing pieces."
},
"missingPieces": {
"type": "string",
"description": "Description of the missing pieces. "
},
"missingPiecesDate": {
"type": "string",
"description": "Date when the piece(s) went missing."
},
"itemDamagedStatusId": {
"description": "Item dame status id identifier.",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date and time when the item was damaged.",
"type": "string"
},
"notes": {
"type": "array",
"description": "Notes about action, copy, binding etc.",
"items": {
"type": "object",
"properties": {
"itemNoteTypeId": {
"type": "string",
"description": "ID of the type of note"
},
"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
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the circulation note"
},
"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"
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting. Points to /users/{id} resource.",
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note. The user information is generated by the server and needed to support sorting. Points to /users/{id} resource."
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"properties": {
"lastName": {
"description": "The user's last name",
"type": "string"
},
"firstName": {
"description": "The user's first name",
"type": "string"
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting."
},
"staffOnly": {
"type": "boolean",
"description": "Flag to restrict display of this note",
"default": false
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the status e.g. Available, Checked out, In transit",
"type": "string",
"enum": [
"Available",
"Awaiting pickup",
"Awaiting delivery",
"Checked out",
"In process",
"In transit",
"Missing",
"On order",
"Paged",
"Declared lost",
"Order closed",
"Claimed returned"
]
},
"date": {
"description": "Date and time when the status was last changed",
"type": "string",
"format": "date-time",
"readonly": true
}
},
"required": [
"name"
],
"additionalProperties": false
},
"materialTypeId": {
"type": "string",
"description": "Material type, term. Define what type of thing the item is."
},
"permanentLoanTypeId": {
"type": "string",
"description": "The permanent loan type, is the default loan type for a given item. Loan types are tenant-defined."
},
"temporaryLoanTypeId": {
"type": "string",
"description": "Temporary loan type, is the temporary loan type for a given item."
},
"permanentLocationId": {
"type": "string",
"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."
},
"temporaryLocationId": {
"type": "string",
"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."
},
"effectiveLocationId": {
"type": "string",
"description": "Read only current home location for 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}$"
},
"electronicAccess": {
"type": "array",
"description": "References for accessing the item by URL.",
"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"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"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}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"tags": {
"description": "arbitrary tags associated with this item",
"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"
]
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last scanned in the Inventory app.",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time"
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"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",
"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": [
"materialTypeId",
"permanentLoanTypeId",
"holdingsRecordId",
"status"
]
}
}
},
"additionalProperties": false,
"required": [
"instanceId",
"permanentLocationId"
]
}
},
"instanceRelations": {
"type": "object",
"description": "Collection of the Instance's relations to other instances, like parent-child relations or title successions",
"parentInstances": {
"type": "array",
"description": "The Instance's relations to parent instances",
"items": {
"type": "object",
"properties": {
"subInstanceId": {
"type": "string",
"description": "UUID of the child instance"
},
"superInstanceId": {
"type": "string",
"description": "UUID of the parent instance"
},
"instanceRelationshipTypeId": {
"type": "string",
"description": "UUID of the type of relations - ie a multipart monograph relation"
},
"CREATE_PROVISIONAL_INSTANCE": {
"type": "object",
"description": "Provisional Instance required to create this Instance relationship",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"id": {
"type": "string",
"description": "The system assigned unique ID of the instance record; UUID"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"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)"
},
"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"
},
"matchKey": {
"anyOf": [
{
"type": "string",
"description": "A finished match key string"
},
{
"type": "object",
"description": "A number of properties from which to construct a match key"
}
],
"description": "Optional field for supplying the desire match key for identifying matching Instances. Is removed before passing the Instance object on to FOLIO Inventory."
},
"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"
}
}
},
"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": "string"
},
"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"
},
"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": "string"
},
"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"
]
}
},
"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
}
}
}
},
"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"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"type": "string"
},
"uniqueItems": true
},
"sourceRecordFormat": {
"type": "string",
"description": "Format of the instance source record, if a source record exists (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)",
"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"
}
},
"additionalProperties": false,
"required": [
"source",
"title",
"instanceTypeId"
]
}
}
}
},
"childInstances": {
"type": "array",
"description": "The Instance's relations to child instances",
"items": {
"type": "object",
"properties": {
"subInstanceId": {
"type": "string",
"description": "UUID of the child instance"
},
"superInstanceId": {
"type": "string",
"description": "UUID of the parent instance"
},
"instanceRelationshipTypeId": {
"type": "string",
"description": "UUID of the type of relations - ie a multipart monograph relation"
},
"CREATE_PROVISIONAL_INSTANCE": {
"type": "object",
"description": "Provisional Instance required to create this Instance relationship",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"id": {
"type": "string",
"description": "The system assigned unique ID of the instance record; UUID"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"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)"
},
"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"
},
"matchKey": {
"anyOf": [
{
"type": "string",
"description": "A finished match key string"
},
{
"type": "object",
"description": "A number of properties from which to construct a match key"
}
],
"description": "Optional field for supplying the desire match key for identifying matching Instances. Is removed before passing the Instance object on to FOLIO Inventory."
},
"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"
}
}
},
"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": "string"
},
"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"
},
"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": "string"
},
"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"
]
}
},
"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
}
}
}
},
"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"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"type": "string"
},
"uniqueItems": true
},
"sourceRecordFormat": {
"type": "string",
"description": "Format of the instance source record, if a source record exists (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)",
"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"
}
},
"additionalProperties": false,
"required": [
"source",
"title",
"instanceTypeId"
]
}
}
}
},
"precedingTitles": {
"type": "array",
"description": "The Instance's relation to preceding title(s)",
"items": {
"type": "object",
"properties": {
"succeedingInstanceId": {
"type": "string",
"description": "UUID of the succeeding title (this Instance)"
},
"precedingInstanceId": {
"type": "string",
"description": "UUID of the preceding title"
},
"CREATE_PROVISIONAL_INSTANCE": {
"type": "object",
"description": "Provisional Instance required to create this Instance relationship",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"id": {
"type": "string",
"description": "The system assigned unique ID of the instance record; UUID"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"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)"
},
"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"
},
"matchKey": {
"anyOf": [
{
"type": "string",
"description": "A finished match key string"
},
{
"type": "object",
"description": "A number of properties from which to construct a match key"
}
],
"description": "Optional field for supplying the desire match key for identifying matching Instances. Is removed before passing the Instance object on to FOLIO Inventory."
},
"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"
}
}
},
"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": "string"
},
"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"
},
"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": "string"
},
"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"
]
}
},
"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
}
}
}
},
"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"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"type": "string"
},
"uniqueItems": true
},
"sourceRecordFormat": {
"type": "string",
"description": "Format of the instance source record, if a source record exists (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)",
"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"
}
},
"additionalProperties": false,
"required": [
"source",
"title",
"instanceTypeId"
]
}
}
}
},
"succeedingTitles": {
"type": "array",
"description": "The Instance's relation to succeeding title(s)",
"items": {
"type": "object",
"properties": {
"succeedingInstanceId": {
"type": "string",
"description": "UUID of the succeeding title"
},
"precedingInstanceId": {
"type": "string",
"description": "UUID of the preceding title (this Instance)"
},
"CREATE_PROVISIONAL_INSTANCE": {
"type": "object",
"description": "Provisional Instance required to create this Instance relationship",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"id": {
"type": "string",
"description": "The system assigned unique ID of the instance record; UUID"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"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)"
},
"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"
},
"matchKey": {
"anyOf": [
{
"type": "string",
"description": "A finished match key string"
},
{
"type": "object",
"description": "A number of properties from which to construct a match key"
}
],
"description": "Optional field for supplying the desire match key for identifying matching Instances. Is removed before passing the Instance object on to FOLIO Inventory."
},
"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"
}
}
},
"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": "string"
},
"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"
},
"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": "string"
},
"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"
]
}
},
"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
}
}
}
},
"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"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"type": "string"
},
"uniqueItems": true
},
"sourceRecordFormat": {
"type": "string",
"description": "Format of the instance source record, if a source record exists (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)",
"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"
}
},
"additionalProperties": false,
"required": [
"source",
"title",
"instanceTypeId"
]
}
}
}
}
},
"metrics": {
"type": "object",
"description": "Reports the number of operations performed by record type, transaction type, and outcome",
"properties": {
"INSTANCE": {
"type": "object",
"description": "Reports the number of operations performed on Instance records by transaction type and outcome",
"properties": {
"CREATED": {
"type": "object",
"description": "Reports the number of Instance create operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed Instance create operations (0 or 1)"
},
"FAILED": {
"type": "integer",
"description": "Number of failed Instance create operations (0 or 1)"
},
"SKIPPED": {
"type": "integer",
"description": "Number of Instance create operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of Instance create operations not completed (should always be 0)"
}
}
},
"UPDATED": {
"type": "object",
"description": "Reports the number of Instance update operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed Instance update operations (0 or 1)"
},
"FAILED": {
"type": "integer",
"description": "Number of failed Instance update operations (0 or 1)"
},
"SKIPPED": {
"type": "integer",
"description": "Number of Instance update operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of Instance update operations not completed (should always be 0)"
}
}
},
"DELETED": {
"type": "object",
"description": "Reports the number of Instance delete operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed Instance delete operations (0 or 1)"
},
"FAILED": {
"type": "integer",
"description": "Number of failed Instance delete operations (0 or 1)"
},
"SKIPPED": {
"type": "integer",
"description": "Number of Instance delete operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of Instance delete operations not completed (should always be 0)"
}
}
}
}
},
"HOLDINGS_RECORD": {
"type": "object",
"description": "Reports the number of operations performed on holdings records by transaction type and outcome",
"properties": {
"CREATED": {
"type": "object",
"description": "Reports the number of HoldingsRecord create operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed HoldingsRecord create operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed HoldingsRecord create operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of HoldingsRecord create operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of HoldingsRecord create operations not completed (should always be 0)"
}
}
},
"UPDATED": {
"type": "object",
"description": "Reports the number of HoldingsRecord update operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed HoldingsRecord update operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed HoldingsRecord update operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of HoldingsRecord update operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of HoldingsRecord update operations not completed (should always be 0)"
}
}
},
"DELETED": {
"type": "object",
"description": "Reports the number of HoldingsRecord delete operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed HoldingsRecord delete operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed HoldingsRecord delete operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of HoldingsRecord delete operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of HoldingsRecord delete operations not completed (should always be 0)"
}
}
}
}
},
"ITEM": {
"type": "object",
"description": "Reports the number of operations performed on Items by transaction type and outcome",
"properties": {
"CREATED": {
"type": "object",
"description": "Reports the number of Item create operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed Item create operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed Item create operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of Item create operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of Item create operations not completed (should always be 0)"
}
}
},
"UPDATED": {
"type": "object",
"description": "Reports the number of Item update operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed Item update operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed Item update operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of Item update operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of Item update operations not completed (should always be 0)"
}
}
},
"DELETED": {
"type": "object",
"description": "Reports the number of Item delete operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed Item delete operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed Item delete operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of Item delete operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of Item delete operations not completed (should always be 0)"
}
}
}
}
},
"INSTANCE_RELATIONSHIP": {
"type": "object",
"description": "Reports the number of operations performed for the Instance's parent-child relationships",
"properties": {
"CREATED": {
"type": "object",
"description": "Reports the number of relationship create operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed relationship create operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed relationship create operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of relationship create operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of Item relationship operations not completed (should always be 0)"
}
}
},
"DELETED": {
"type": "object",
"description": "Reports the number of relationship delete operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed relationship delete operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed relationship delete operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of relationship delete operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of relationship delete operations not completed (should always be 0)"
}
}
},
"PROVISIONAL_INSTANCE": {
"type": "object",
"description": "If the parent or child didn't exist in Inventory yet, this will report on operation for creating a provisional Instance",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "1 if the other Instance was successfully created"
},
"FAILED": {
"type": "integer",
"description": "1 if the creation of the other Instance failed"
},
"SKIPPED": {
"type": "integer",
"description": "1 if creation of the other Instance was skipped (should always be 0)"
},
"PENDING": {
"type": "integer",
"description": "1 if creation was required but not completed (should always be 0)"
}
}
}
}
},
"INSTANCE_TITLE_SUCCESSION": {
"type": "object",
"description": "Reports the number of operations performed for the Instance's parent-child relationships",
"properties": {
"CREATED": {
"type": "object",
"description": "Reports the number of title succession create operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed title succession create operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed title succession create operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of title succession create operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of title succession create operations not completed (should always be 0)"
}
}
},
"DELETED": {
"type": "object",
"description": "Reports the number of title succession delete operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed title succession delete operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed title succession delete operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of title succession delete operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of title succession delete operations not completed (should always be 0)"
}
}
},
"PROVISIONAL_INSTANCE": {
"type": "object",
"description": "If the successive title didn't exist in Inventory yet, this will report on operation for creating a provisional title",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "1 if the other title was successfully created"
},
"FAILED": {
"type": "integer",
"description": "1 if the creation of the other title failed"
},
"SKIPPED": {
"type": "integer",
"description": "1 if creation of the other title was skipped (should always be 0)"
},
"PENDING": {
"type": "integer",
"description": "1 if creation was required but not completed (should always be 0)"
}
}
}
}
}
}
}
}
}One or more problems encountered when creating/updating an Inventory record set by HRIDs
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Response on an upsert request that encountered one or more problems",
"type": "object",
"properties": {
"instance": {
"type": "object",
"description": "The Instance, the bibliographic part, of this Inventory record set as it was pushed to Inventory storage",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"id": {
"type": "string",
"description": "The system assigned unique ID of the instance record; UUID"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"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)"
},
"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"
},
"matchKey": {
"anyOf": [
{
"type": "string",
"description": "A finished match key string"
},
{
"type": "object",
"description": "A number of properties from which to construct a match key"
}
],
"description": "Optional field for supplying the desire match key for identifying matching Instances. Is removed before passing the Instance object on to FOLIO Inventory."
},
"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"
}
}
},
"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": "string"
},
"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"
},
"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": "string"
},
"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"
]
}
},
"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
}
}
}
},
"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"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"type": "string"
},
"uniqueItems": true
},
"sourceRecordFormat": {
"type": "string",
"description": "Format of the instance source record, if a source record exists (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)",
"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"
}
},
"additionalProperties": false,
"required": [
"source",
"title",
"instanceTypeId"
]
},
"holdingsRecords": {
"type": "array",
"description": "Collection of holdings of the Instance, each holdings record with embedded items as it was pushed to Inventory storage",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A holdings record",
"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}$"
},
"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": {
"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}$"
},
"electronicAccess": {
"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"
]
}
},
"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": {
"type": "string",
"description": "Format of holdings record acquisition"
},
"acquisitionMethod": {
"type": "string",
"description": "Method of holdings record acquisition"
},
"receiptStatus": {
"type": "string",
"description": "Receipt status (e.g. pending, awaiting receipt, partially received, fully received, receipt not required, and cancelled)"
},
"notes": {
"type": "array",
"description": "Notes about action, copy, binding etc.",
"items": {
"type": "object",
"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": {
"type": "string"
},
"holdingsStatements": {
"type": "array",
"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"
}
}
}
},
"holdingsStatementsForIndexes": {
"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"
}
}
}
},
"holdingsStatementsForSupplements": {
"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"
}
}
}
},
"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": {
"type": "object",
"properties": {
"displayType": {
"type": "string",
"description": "Display hint. 1: Display fields separately. 2: Display fields concatenated"
},
"entries": {
"type": "array",
"description": ".",
"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"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"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}$"
},
"uniqueItems": true
},
"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"
]
},
"items": {
"type": "array",
"items": {
"description": "Inventory items for this holdings record",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the item record"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID"
},
"holdingsRecordId": {
"type": "string",
"description": "ID of the holdings record the item is a member of."
},
"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"
},
"accessionNumber": {
"type": "string",
"description": "Also called inventar number"
},
"barcode": {
"type": "string",
"description": "Unique inventory control number for physical resources, used largely for circulation purposes"
},
"itemLevelCallNumber": {
"type": "string",
"description": "Call Number is an identifier assigned to an item, usually printed on a label attached to the item. The call number is used to determine the items physical position in a shelving sequence, e.g. K1 .M44. The Item level call number, is the call number on item level."
},
"itemLevelCallNumberPrefix": {
"type": "string",
"description": "Prefix of the call number on the item level."
},
"itemLevelCallNumberSuffix": {
"type": "string",
"description": "Suffix of the call number on the item level."
},
"itemLevelCallNumberTypeId": {
"type": "string",
"description": "Identifies the source of the call number, e.g., LCC, Dewey, NLM, etc."
},
"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 of the item, if available, otherwise that of the 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}$"
}
},
"additionalProperties": false
},
"volume": {
"type": "string",
"description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of George Bernard Shaw in three volumes)."
},
"enumeration": {
"type": "string",
"description": "Enumeration is the descriptive information for the numbering scheme of a serial."
},
"chronology": {
"type": "string",
"description": "Chronology is the descriptive information for the dating scheme of a serial."
},
"yearCaption": {
"type": "array",
"description": "In multipart monographs, a caption is a character(s) used to label a level of chronology, e.g., year 1985.",
"items": {
"type": "string"
},
"uniqueItems": true
},
"itemIdentifier": {
"type": "string",
"description": "Item identifier number, e.g. imported from the union catalogue (read only)."
},
"copyNumber": {
"type": "string",
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; one copy of a multi-volume, (e.g. Copy 1, or C.7.)"
},
"numberOfPieces": {
"type": "string",
"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)."
},
"descriptionOfPieces": {
"description": "Description of item pieces.",
"type": "string"
},
"numberOfMissingPieces": {
"type": "string",
"description": "Number of missing pieces."
},
"missingPieces": {
"type": "string",
"description": "Description of the missing pieces. "
},
"missingPiecesDate": {
"type": "string",
"description": "Date when the piece(s) went missing."
},
"itemDamagedStatusId": {
"description": "Item dame status id identifier.",
"type": "string"
},
"itemDamagedStatusDate": {
"description": "Date and time when the item was damaged.",
"type": "string"
},
"notes": {
"type": "array",
"description": "Notes about action, copy, binding etc.",
"items": {
"type": "object",
"properties": {
"itemNoteTypeId": {
"type": "string",
"description": "ID of the type of note"
},
"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
}
}
}
},
"circulationNotes": {
"type": "array",
"description": "Notes to be displayed in circulation processes",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the circulation note"
},
"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"
},
"source": {
"type": "object",
"description": "The user who added/updated the note. The property is generated by the server and needed to support sorting. Points to /users/{id} resource.",
"properties": {
"id": {
"type": "string",
"description": "The id of the user who added/updated the note. The user information is generated by the server and needed to support sorting. Points to /users/{id} resource."
},
"personal": {
"type": "object",
"description": "Personal information about the user",
"properties": {
"lastName": {
"description": "The user's last name",
"type": "string"
},
"firstName": {
"description": "The user's first name",
"type": "string"
}
}
}
}
},
"date": {
"type": "string",
"description": "Date and time the record is added/updated. The property is generated by the server and needed to support sorting."
},
"staffOnly": {
"type": "boolean",
"description": "Flag to restrict display of this note",
"default": false
}
},
"additionalProperties": false
}
},
"status": {
"description": "The status of the item",
"type": "object",
"properties": {
"name": {
"description": "Name of the status e.g. Available, Checked out, In transit",
"type": "string",
"enum": [
"Available",
"Awaiting pickup",
"Awaiting delivery",
"Checked out",
"In process",
"In transit",
"Missing",
"On order",
"Paged",
"Declared lost",
"Order closed",
"Claimed returned"
]
},
"date": {
"description": "Date and time when the status was last changed",
"type": "string",
"format": "date-time",
"readonly": true
}
},
"required": [
"name"
],
"additionalProperties": false
},
"materialTypeId": {
"type": "string",
"description": "Material type, term. Define what type of thing the item is."
},
"permanentLoanTypeId": {
"type": "string",
"description": "The permanent loan type, is the default loan type for a given item. Loan types are tenant-defined."
},
"temporaryLoanTypeId": {
"type": "string",
"description": "Temporary loan type, is the temporary loan type for a given item."
},
"permanentLocationId": {
"type": "string",
"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."
},
"temporaryLocationId": {
"type": "string",
"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."
},
"effectiveLocationId": {
"type": "string",
"description": "Read only current home location for 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}$"
},
"electronicAccess": {
"type": "array",
"description": "References for accessing the item by URL.",
"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"
]
}
},
"inTransitDestinationServicePointId": {
"description": "Service point an item is intended to be transited to (should only be present when in transit)",
"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}$"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"type": "string"
},
"uniqueItems": true
},
"purchaseOrderLineIdentifier": {
"type": "string",
"description": "ID referencing a remote purchase order object related to this item"
},
"tags": {
"description": "arbitrary tags associated with this item",
"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"
]
},
"lastCheckIn": {
"type": "object",
"additionalProperties": false,
"description": "Information about when an item was last scanned in the Inventory app.",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time of the last check in of the item.",
"format": "date-time"
},
"servicePointId": {
"type": "string",
"description": "Service point ID being used by a staff member when item was scanned in Check in app.",
"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",
"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": [
"materialTypeId",
"permanentLoanTypeId",
"holdingsRecordId",
"status"
]
}
}
},
"additionalProperties": false,
"required": [
"instanceId",
"permanentLocationId"
]
}
},
"metrics": {
"type": "object",
"description": "Reports the number of operations performed by record type, transaction type, and outcome",
"properties": {
"INSTANCE": {
"type": "object",
"description": "Reports the number of operations performed on Instance records by transaction type and outcome",
"properties": {
"CREATED": {
"type": "object",
"description": "Reports the number of Instance create operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed Instance create operations (0 or 1)"
},
"FAILED": {
"type": "integer",
"description": "Number of failed Instance create operations (0 or 1)"
},
"SKIPPED": {
"type": "integer",
"description": "Number of Instance create operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of Instance create operations not completed (should always be 0)"
}
}
},
"UPDATED": {
"type": "object",
"description": "Reports the number of Instance update operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed Instance update operations (0 or 1)"
},
"FAILED": {
"type": "integer",
"description": "Number of failed Instance update operations (0 or 1)"
},
"SKIPPED": {
"type": "integer",
"description": "Number of Instance update operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of Instance update operations not completed (should always be 0)"
}
}
},
"DELETED": {
"type": "object",
"description": "Reports the number of Instance delete operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed Instance delete operations (0 or 1)"
},
"FAILED": {
"type": "integer",
"description": "Number of failed Instance delete operations (0 or 1)"
},
"SKIPPED": {
"type": "integer",
"description": "Number of Instance delete operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of Instance delete operations not completed (should always be 0)"
}
}
}
}
},
"HOLDINGS_RECORD": {
"type": "object",
"description": "Reports the number of operations performed on holdings records by transaction type and outcome",
"properties": {
"CREATED": {
"type": "object",
"description": "Reports the number of HoldingsRecord create operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed HoldingsRecord create operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed HoldingsRecord create operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of HoldingsRecord create operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of HoldingsRecord create operations not completed (should always be 0)"
}
}
},
"UPDATED": {
"type": "object",
"description": "Reports the number of HoldingsRecord update operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed HoldingsRecord update operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed HoldingsRecord update operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of HoldingsRecord update operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of HoldingsRecord update operations not completed (should always be 0)"
}
}
},
"DELETED": {
"type": "object",
"description": "Reports the number of HoldingsRecord delete operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed HoldingsRecord delete operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed HoldingsRecord delete operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of HoldingsRecord delete operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of HoldingsRecord delete operations not completed (should always be 0)"
}
}
}
}
},
"ITEM": {
"type": "object",
"description": "Reports the number of operations performed on Items by transaction type and outcome",
"properties": {
"CREATED": {
"type": "object",
"description": "Reports the number of Item create operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed Item create operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed Item create operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of Item create operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of Item create operations not completed (should always be 0)"
}
}
},
"UPDATED": {
"type": "object",
"description": "Reports the number of Item update operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed Item update operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed Item update operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of Item update operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of Item update operations not completed (should always be 0)"
}
}
},
"DELETED": {
"type": "object",
"description": "Reports the number of Item delete operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed Item delete operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed Item delete operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of Item delete operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of Item delete operations not completed (should always be 0)"
}
}
}
}
},
"INSTANCE_RELATIONSHIP": {
"type": "object",
"description": "Reports the number of operations performed for the Instance's parent-child relationships",
"properties": {
"CREATED": {
"type": "object",
"description": "Reports the number of relationship create operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed relationship create operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed relationship create operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of relationship create operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of Item relationship operations not completed (should always be 0)"
}
}
},
"DELETED": {
"type": "object",
"description": "Reports the number of relationship delete operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed relationship delete operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed relationship delete operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of relationship delete operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of relationship delete operations not completed (should always be 0)"
}
}
}
}
},
"INSTANCE_TITLE_SUCCESSION": {
"type": "object",
"description": "Reports the number of operations performed for the Instance's parent-child relationships",
"properties": {
"CREATED": {
"type": "object",
"description": "Reports the number of title succession create operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed title succession create operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed title succession create operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of title succession create operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of title succession create operations not completed (should always be 0)"
}
}
},
"DELETED": {
"type": "object",
"description": "Reports the number of title succession delete operations by outcome",
"properties": {
"COMPLETED": {
"type": "integer",
"description": "Number of successfully completed title succession delete operations"
},
"FAILED": {
"type": "integer",
"description": "Number of failed title succession delete operations"
},
"SKIPPED": {
"type": "integer",
"description": "Number of title succession delete operations that were skipped"
},
"PENDING": {
"type": "integer",
"description": "Number of title succession delete operations not completed (should always be 0)"
}
}
}
}
}
}
},
"errors": {
"type": "array",
"description": "List of problems encountered during an Inventory update or delete request",
"items": {
"type": "object",
"properties": {
"entityType": {
"type": "string",
"description": "The record type for which a problem occurred"
},
"transaction": {
"type": "string",
"description": "Type of REST operation for which the problem occurred"
},
"statusCode": {
"type": "string",
"description": "The HTTP status code returned by Inventory storage"
},
"shortMessage": {
"type": "string",
"description": "A short error message that might be used by the client to count similar error occurrences"
},
"message": {
"anyOf": [
{
"type": "string",
"description": "Error text returned by Inventory storage"
},
{
"type": "object",
"description": "JSON object of one or more structured error messages returned by Inventory storage"
}
]
},
"entity": {
"type": "object",
"description": "The JSON object that was pushed to Inventory storage when the problem occurred"
}
}
}
}
}
}DELETE /inventory-upsert-hridMedia type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Deletion record for deletion by HRID",
"type": "object",
"properties": {
"hrid": {
"type": "string",
"description": "The legacy ID for the bibliographic record, as stored in the HRID of the Instance to be deleted."
}
},
"required": [
"hrid"
]
}Record set was successfully found by HRID and deleted
Bad request, for example: non-JSON in request body; inventory record set without an Instance
Did not find existing Instance (record set) to delete for provided HRID
One or more problems were encountered when attempting to delete inventory record set
Error during delete by HRID
PUT /instance-storage-match/instancesMedia 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; UUID"
},
"hrid": {
"type": "string",
"description": "The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
},
"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)"
},
"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"
},
"matchKey": {
"anyOf": [
{
"type": "string",
"description": "A finished match key string"
},
{
"type": "object",
"description": "A number of properties from which to construct a match key"
}
],
"description": "Optional field for supplying the desire match key for identifying matching Instances. Is removed before passing the Instance object on to FOLIO Inventory."
},
"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"
}
}
},
"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": "string"
},
"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"
},
"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": "string"
},
"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"
]
}
},
"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
}
}
}
},
"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"
},
"statisticalCodeIds": {
"type": "array",
"description": "List of statistical code IDs",
"items": {
"type": "string"
},
"uniqueItems": true
},
"sourceRecordFormat": {
"type": "string",
"description": "Format of the instance source record, if a source record exists (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)",
"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"
}
},
"additionalProperties": false,
"required": [
"source",
"title",
"instanceTypeId"
]
}