Real Time Availability Check version v1.5

https://github.com/folio-org/mod-rtac

DEPRECATED Real Time Availability Checker Integration

This module allows 3rd party discovery services to check for FOLIO inventory availability

DEPRECATED RTAC

DEPRECATED RTAC operations

get

Returns availability details about each item for the given instance id

get

Retrieve rtac item with given {rtacId}

Retrieve rtac item with given {rtacId}

URI Parameters

  • id: required(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}$)

    The UUID of a FOLIO instance

HTTP status code 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "additionalProperties": false,
  "javaType": "org.folio.rest.jaxrs.model.LegacyHoldings",
  "description": "Collection of holdings",
  "properties": {
    "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",
        "javaType": "org.folio.rest.jaxrs.model.LegacyHolding",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "description": "The FOLIO id of the holding (item)"
          },
          "location": {
            "type": "string",
            "description": "The location 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)"
          }
        },
        "required": [
          "id",
          "location",
          "callNumber",
          "status"
        ]
      }
    }
  },
  "required": [
    "holdings"
  ]
}

Example:

{
  "holdings" : [
    {
      "id": "112ae2e4-88ae-4fa5-a75b-2379d2035e52",
      "location": "Sample Library",
      "callNumber": "123456",
      "status": "On loan",
      "dueDate": "2018-05-01T12:01:59Z"
    }
  ]
}

HTTP status code 400

Bad request

Body

Media type: text/plain

Type: any

Example:

"unable to process request -- constraint violation"

HTTP status code 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to get retrieve rtac -- unauthorized

HTTP status code 403

Access Denied

Body

Media type: text/plain

Type: any

Example:

Access Denied

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"rtac not found"

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator