https://github.com/folio-org/mod-rtac
This module allows 3rd party discovery services to check for FOLIO inventory availability
Batch API to get instances with items and holdings from inventory. The expectation is that the mode of issuance "serial" and nature of content "journal" and "newspaper" are present in the target system. The module uses these values to qualify an instance as a periodical.
Retrieve holding information from inventory in a batch
POST /rtac-batchMedia type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Define format of request data with instances ids",
"type": "object",
"properties": {
"instanceIds": {
"description": "Inventory instances identifiers",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/",
"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}$"
}
},
"fullPeriodicals": {
"description": "if set to true, then item-level information is added to all periodicals without holdings-level information",
"type": "boolean",
"default": false
}
},
"additionalProperties": false,
"required": [
"instanceIds"
]
}Example:
{
"instanceIds": [
"5bf370e0-8cca-4d9c-82e4-5170ab2a0a39",
"7212ba6a-8dcf-45a1-be9a-ffaa847c4423",
"100d10bf-2f06-4aa0-be15-0b95b2d9f9e3",
"0aaef1ea-69eb-4f6e-a077-cea159317ce3",
"1b74ab75-9f41-4837-8662-a1d99118008d"
],
"fullPeriodicals" : false
}
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "Batch holdings response",
"properties": {
"holdings": {
"description": "Real Time Availability Check (RTAC) holding details",
"type": "array",
"id": "holdingsList",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"description": "Collection of holdings",
"javaType": "org.folio.rest.jaxrs.model.RtacHoldings",
"properties": {
"instanceId": {
"description": "The FOLIO instance identifier",
"type": "string",
"$schema": "http://json-schema.org/draft-04/schema#",
"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}$"
},
"holdings": {
"description": "Collection of holdings",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "RTAC Holding Schema",
"description": "Real Time Availability Check (RTAC) holding details",
"additionalProperties": false,
"javaType": "org.folio.rest.jaxrs.model.RtacHolding",
"properties": {
"id": {
"type": "string",
"description": "The FOLIO id of the holding (item)"
},
"barcode": {
"description": "Unique inventory control number for physical resources, used largely for circulation purposes",
"type": "string"
},
"location": {
"type": "string",
"description": "The location of the holding"
},
"locationCode": {
"type": "string",
"description": "The location code of the holding"
},
"locationId": {
"type": "string",
"description": "The location id of the holding"
},
"callNumber": {
"type": "string",
"description": "The call number of the holding"
},
"status": {
"type": "string",
"description": "The availability status of the holding"
},
"dueDate": {
"type": "string",
"format": "date-time",
"description": "The date when the holding will be available"
},
"volume": {
"type": "string",
"description": "Volume details for the holding (item)"
},
"temporaryLoanType": {
"type": "string",
"description": "Name of the temporary loan type for a given item"
},
"permanentLoanType": {
"type": "string",
"description": "Name of the default loan type for a given item"
},
"materialType": {
"type": "object",
"description": "Define what type of thing the item is",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"id": {
"type": "string"
},
"name": {
"description": "label for the material type",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name"
]
},
"library": {
"type": "object",
"description": "The third-level location unit",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"name": {
"description": "name of the location",
"type": "string"
},
"code": {
"description": "distinct code for the location",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"name",
"code"
]
},
"suppressFromDiscovery": {
"description": "Indicate if record should not be displayed in a discovery system",
"type": "boolean"
},
"totalHoldRequests": {
"description": "The total number of requested items for the patron",
"type": "integer"
},
"notes": {
"description": "Notes about action, copy, binding etc.",
"type": "array",
"items": {
"type": "object",
"properties": {
"holdingsNoteTypeName": {
"description": "Name of the holdings note type",
"type": "string"
},
"note": {
"description": "Text content of the note",
"type": "string"
}
},
"required": [
"holdingsNoteTypeName",
"note"
]
}
},
"holdingsStatements": {
"description": "Notes about action, copy, binding etc.",
"type": "array",
"items": {
"type": "object",
"properties": {
"statement": {
"description": "Name of the holdings note type",
"type": "string"
},
"note": {
"description": "Text content of the note",
"type": "string"
}
}
}
},
"holdingsStatementsForIndexes": {
"description": "Holdings record indexes statements",
"type": "array",
"items": {
"type": "object",
"properties": {
"statement": {
"description": "Textual description of the holdings of indexes",
"type": "string"
},
"note": {
"description": "Note attached to a holdings statement",
"type": "string"
}
}
}
},
"holdingsStatementsForSupplements": {
"description": "Holdings record supplements statements",
"type": "array",
"items": {
"type": "object",
"properties": {
"statement": {
"description": "Textual description of the holdings of supplementary material",
"type": "string"
},
"note": {
"description": "Note attached to a holdings statement",
"type": "string"
}
}
}
},
"holdingsCopyNumber": {
"type": "string",
"description": "Piece ID (usually barcode) for systems that do not use holdings record"
},
"itemCopyNumber": {
"type": "string",
"description": "Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; a copy of a multi-volume, (e.g. Copy 1, or C.7.)"
},
"itemDisplayOrder": {
"type": "integer",
"description": "Order of the item in the holdings record."
}
},
"required": [
"id",
"location",
"callNumber",
"status"
]
}
}
},
"required": [
"holdings"
]
}
},
"errors": {
"description": "Errors",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "error.schema",
"description": "An error",
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "parameters.schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
},
"minimum": 0
}
},
"additionalItems": false,
"additionalProperties": false
}Bad request
Media type: text/plain
Type: any
Example:
"unable to process request -- constraint violation"
Access Denied
Media type: text/plain
Type: any
Example:
Access DeniedNot Found
Media type: text/plain
Type: any
Example:
Not FoundValidation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "errors.schema",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "error.schema",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "parameters.schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error
Media type: text/plain
Type: any
Example:
Internal server error