Skip FOLIO Project Navigation

Introduction

These API specifications are automatically generated from each repository’s RAML files, and specify how client modules may access the functionality provided by these important core modules.

  • view-1: Uses pop-up windows for each method and endpoint.
  • view-2: Uses one-page view to everything.

okapi

APIs
okapi view-1 view-2

mod-users

APIs *
groups view-1 view-2
users view-1 view-2
addressTypes view-1 view-2
proxiesFor view-1 view-2

mod-users-bl

APIs *
mod-users-bl view-1 view-2

mod-permissions

APIs *
tenantPermissions view-1 view-2
permissions view-1 view-2

mod-login

APIs *
login view-1 view-2

mod-login-saml

APIs
saml-login view-1 view-2

mod-circulation

APIs
circulation view-1 view-2

mod-circulation-storage

APIs
loan-storage view-1 view-2
loan-policy-storage view-1 view-2
loan-rules-storage view-1 view-2
request-storage view-1 view-2
fixed-due-date-schedule view-1 view-2
cancellation-reason view-1 view-2
staff-slips view-1 view-2

mod-configuration

APIs
config view-1 view-2

mod-inventory

APIs
inventory view-1 view-2

mod-inventory-storage

APIs
holdings-storage view-1 view-2
instance-storage view-1 view-2
instance-format view-1 view-2
instance-type view-1 view-2
item-storage view-1 view-2
classification-type view-1 view-2
contributor-type view-1 view-2
contributor-name-type view-1 view-2
identifier-type view-1 view-2
loan-type view-1 view-2
location view-1 view-2
locationunit view-1 view-2
material-type view-1 view-2
platform view-1 view-2
service-point view-1 view-2
shelf-location view-1 view-2

mod-user-import

APIs
import view-1 view-2

mod-codex-ekb

APIs *
codex view-1 view-2

mod-codex-inventory

APIs *
codex view-1 view-2

mod-codex-mux

APIs *
codex view-1 view-2

mod-calendar

APIs
calendar view-1 view-2

mod-finance

APIs
budget view-1 view-2
fiscal_year view-1 view-2
fund_distribution view-1 view-2
funds view-1 view-2
ledger view-1 view-2
tag view-1 view-2
transaction view-1 view-2

mod-feesfines

APIs
accounts view-1 view-2
chargeitem view-1 view-2
comments view-1 view-2
feefineactions view-1 view-2
feefinehistory view-1 view-2
feefines view-1 view-2
owners view-1 view-2
payments view-1 view-2
refunds view-1 view-2
transfers view-1 view-2
transfertypes view-1 view-2
waives view-1 view-2

mod-notes

APIs
note view-1 view-2

mod-notify

APIs
notify view-1 view-2

mod-tags

APIs
tags view-1 view-2

mod-kb-ebsco

APIs
eholdings view-1

mod-rtac

APIs
rtac view-1 view-2

mod-patron

APIs
patron view-1 view-2

mod-data-loader

APIs
loader view-1 view-2

mod-orders

APIs
order view-1 view-2

mod-orders-storage

APIs
adjustment view-1 view-2
alert view-1 view-2
claim view-1 view-2
cost view-1 view-2
details view-1 view-2
eresource view-1 view-2
fund_distribution view-1 view-2
license view-1 view-2
location view-1 view-2
order_format view-1 view-2
order_type view-1 view-2
physical view-1 view-2
po_line view-1 view-2
purchase_order view-1 view-2
receipt_status view-1 view-2
renewal view-1 view-2
source view-1 view-2
vendor view-1 view-2
workflow_status view-1 view-2

mod-vendors

APIs
vendor view-1 view-2
contact_category view-1 view-2
vendor_category view-1 view-2

mod-gobi

APIs
gobi view-1 view-2

edge-patron

APIs
edge-patron view-1 view-2

edge-rtac

APIs
edge-rtac view-1 view-2

edge-orders

APIs
edge-orders view-1 view-2

raml-module-builder

APIs
admin view-1 view-2
jobs view-1 view-2
sample view-1 view-2

raml

This is the shared RAML repository. Refer to the relevant table above, as each module uses a certain version of this as their "raml-util" directory.

Label APIs
shared tenant view-1 view-2
shared-mod-login login view-1 view-2
shared-mod-permissions tenantPermissions view-1 view-2
shared-mod-permissions permissions view-1 view-2
shared-mod-users groups view-1 view-2
shared-mod-users users view-1 view-2
shared-mod-users addressTypes view-1 view-2
shared-mod-users proxiesFor view-1 view-2
shared-mod-users-bl mod-users-bl view-1 view-2
shared-codex codex view-1 view-2
tagged-record-example users view-1 view-2

Configuration

See explanation for how to configure the generation of API documentation of each back-end module.

Usage notes

  • The asterisk * denotes that this is a shared set of RAML files. The generated documents are for this module’s current raml-util, but the link to the source RAML file is to the master of the shared “raml” repository.

  • Since August 2018 the generated documents are saved for each software version. So for mod-inventory-storage amend the URL of the generated documents to add the version number (major.minor), e.g. mod-inventory-storage/12.5/...