"edge" API for RTAC (RealTime Availability Check)
Clone or download
Latest commit 38bf79e Dec 5, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
descriptors
docker
ramls
src
.editorconfig
.gitignore
CONTRIBUTING.md
Dockerfile
Jenkinsfile
LICENSE
NEWS.md
README.md
pom.xml

README.md

edge-rtac

Copyright (C) 2018 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

Introduction

Edge API to interface with FOLIO for 3rd party discovery services to determine holdings availability.

Overview

The purpose of this edge API is to bridge the gap between 3rd party discovery services and FOLIO. More specifically, the initial implementation was built with EBSCO's Real Time Availability Check (RTAC) service in mind. RTAC is used by the EBSCO Discovery Service (EDS) to obtain up-to-date holdings information (status, call number, location, due date, etc.).

In order to reduce the amount of integration work on the discovery side, the API implemented here mimics an existing RTAC integration. This includes the parameter names, data formats, API endpoint names, among other things. There are certain quirks about the API being mimicked that may seem unintuitive, such as failures of any sort still result in 200 response, but with an empty <holdings/> XML payload. Eventually all this will be documented.

Security

See edge-common for a description of the security model.

Configuration

See edge-common for a description of how configuration works.

Additional information

Issue tracker

See project EDGRTAC at the FOLIO issue tracker.

Other documentation

Other modules are described, with further FOLIO Developer documentation at dev.folio.org