Real Time Availability Check (v1.3)

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

Table of contents

Real Time Availability Checker Integration

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

RTAC

RTAC operations

GET /rtac/{id}

Retrieve rtac item with given {rtacId}

GET /rtac/{id}
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

Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 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,
  "description": "Collection of holdings",
  "properties": {
    "holdings": {
      "description": "Collection of holdings",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "holding.json"
      }
    }
  },
  "required": [
    "holdings"
  ]
}

Example:

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

Response 400

Bad request

Body

Media type: text/plain

Type: any

Example:

"unable to process request -- constraint violation"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to get retrieve rtac -- unauthorized

Response 403

Access Denied

Body

Media type: text/plain

Type: any

Example:

Access Denied

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"rtac not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator