Edge API - Real Time Availability Check (v2)

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

Table of contents

Edge API - Real Time Availability Check

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

RTAC Batching

GET /rtac

Batch RTAC for the specified ids

GET /rtac
Query Parameters
  • instanceIds: 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}[, ]*)+$)

    List of Folio instance identifiers

  • fullPeriodicals: required (boolean)

    Flag for including items data

  • apikey: required (string)

    API Key

Response 200

Success

Body

Media type: application/xml

Type: batchHoldings

RTAC

GET /rtac/{instanceId}

RTAC for the specified holding id

GET /rtac/{instanceId}
URI Parameters
  • instanceId: required (string)
Query Parameters
  • fullPeriodicals: required (boolean)

    Flag for including items data

  • apikey: required (string)

    API Key

Response 200

Success

Body

Media type: application/xml

Type: holdings

RTAC

GET /prod/rtac/folioRTAC

RTAC for the specified holding id

GET /prod/rtac/folioRTAC
Query Parameters
  • mms_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

  • apikey: required (string)

    API Key

Response 200

Success

Body

Media type: application/xml

Type: holdings

Health Check

GET /admin/health

Health Check

GET /admin/health

Response 200

Success

Body

Media type: text/plain

Type: any