Skip FOLIO Project Navigation

GitHub and Twitter:

API documentation

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 modules. See usage notes below.

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

This list of modules is sorted into functional groups.

Login

Handling the login process.

mod-login

Source
login.raml view-1 view-2

mod-login-saml

Source
saml-login.raml view-1

mod-password-validator

Source
password-validator.raml view-1 view-2
validator-registry.raml view-1 view-2

mod-permissions

Source
tenantPermissions.raml view-1 view-2
permissions.raml view-1 view-2

Users

Information about users.

mod-users-bl

Source
mod-users-bl.raml view-1 view-2

mod-users

Source
groups.raml view-1 view-2
users.raml view-1 view-2
addressTypes.raml view-1 view-2
proxiesFor.raml view-1 view-2

mod-patron

Source
patron.raml view-1

edge-patron

Source
edge-patron.raml view-1

mod-feesfines

Source
accounts.raml view-1 view-2
comments.raml view-1 view-2
feefineactions.raml view-1 view-2
feefines.raml view-1 view-2
manualblocks.raml view-1 view-2
owners.raml view-1 view-2
payments.raml view-1 view-2
refunds.raml view-1 view-2
transfers.raml view-1 view-2
transfer-criteria.raml view-1 view-2
waiver.raml view-1 view-2

Codex

The FOLIO Codex.

mod-codex-mux

Source *
codex.raml view-1 view-2
codex-packages.raml view-1 view-2

mod-codex-inventory

Source *
codex.raml view-1 view-2

mod-codex-ekb

Source *
codex.raml view-1 view-2
codex-packages.raml view-1 view-2

mod-codex-mock

Source *
codex.raml view-1

Inventory and circulation

Inventory instances, items, and circulation.

mod-circulation

Source
circulation.raml view-1 view-2

mod-circulation-storage

Source
circulation-rules-storage.raml view-1 view-2
loan-storage.raml view-1 view-2
loan-policy-storage.raml view-1 view-2
request-storage.raml view-1 view-2
request-policy-storage.raml view-1 view-2
fixed-due-date-schedule.raml view-1 view-2
cancellation-reason.raml view-1 view-2
patron-notice-policy.raml view-1 view-2
staff-slips.raml view-1 view-2

mod-inventory

Source
inventory.raml view-1 view-2

mod-inventory-storage

Source
holdings-storage.raml view-1 view-2
holdings-type.raml view-1 view-2
holdings-note-type.raml view-1 view-2
instance-storage.raml view-1 view-2
instance-format.raml view-1 view-2
instance-type.raml view-1 view-2
instance-relationship-type.raml view-1 view-2
instance-status.raml view-1 view-2
item-storage.raml view-1 view-2
item-note-type.raml view-1 view-2
alternative-title-type.raml view-1 view-2
call-number-type.raml view-1 view-2
classification-type.raml view-1 view-2
contributor-type.raml view-1 view-2
contributor-name-type.raml view-1 view-2
electronic-access-relationship.raml view-1 view-2
identifier-type.raml view-1 view-2
ill-policy.raml view-1 view-2
loan-type.raml view-1 view-2
location.raml view-1 view-2
locationunit.raml view-1 view-2
material-type.raml view-1 view-2
mode-of-issuance.raml view-1 view-2
service-point.raml view-1 view-2
service-points-user.raml view-1 view-2
shelf-location.raml view-1 view-2
statistical-code.raml view-1 view-2
statistical-code-type.raml view-1 view-2

mod-kb-ebsco

Source
eholdings.raml view-1 view-2

mod-kb-ebsco-java

Source
eholdings.raml view-1 view-2
packages.raml view-1 view-2
providers.raml view-1 view-2
proxies.raml view-1 view-2
resources.raml view-1 view-2
tags.raml view-1 view-2
titles.raml view-1 view-2

mod-oai-pmh

Source
oai-pmh.raml view-1 view-2

edge-oai-pmh

Source
edge-oai-pmh.raml view-1 view-2

mod-marccat

Source
marccat.raml view-1 view-2

Resource management

ERM, licenses, usage statistics.

mod-erm-usage

Source
aggregatorsettings.raml view-1 view-2
counterreports.raml view-1 view-2
usagedataproviders.raml view-1 view-2

mod-erm-usage-harvester

Source
harvester.raml view-1 view-2
start.raml view-1 view-2

mod-licenses

Source
licenses.raml view-1 view-2

mod-finc-config

Source
finc-tenant.raml view-1 view-2
metadataSources.raml view-1 view-2
metadataCollections.raml view-1 view-2

Finance and orders

Finance, orders, vendors.

mod-finance-storage

Source
budget.raml view-1 view-2
encumbrance.raml view-1 view-2
fiscal_year.raml view-1 view-2
fund.raml view-1 view-2
fund_distribution.raml view-1 view-2
ledger.raml view-1 view-2
transaction.raml view-1 view-2

mod-invoice

Source
invoice.raml view-1 view-2

mod-invoice-storage

Source
invoice.raml view-1 view-2
invoice-line-number.raml view-1 view-2
invoice-number.raml view-1 view-2

mod-orders

Source
order.raml view-1 view-2

mod-orders-storage

Source
alert.raml view-1 view-2
orders.raml view-1 view-2
pieces.raml view-1 view-2
po-line.raml view-1 view-2
po-line-number.raml view-1 view-2
po-number.raml view-1 view-2
purchase-order.raml view-1 view-2
receiving-history.raml view-1 view-2
reporting-code.raml view-1 view-2

edge-orders

Source
edge-orders.raml view-1 view-2

mod-organizations-storage

Source
address.raml view-1 view-2
category.raml view-1 view-2
contact.raml view-1 view-2
email.raml view-1 view-2
interface.raml view-1 view-2
organization.raml view-1 view-2
phone_number.raml view-1 view-2
url.raml view-1 view-2

mod-gobi

Source
gobi.raml view-1 view-2

Notifications

Assembling and sending notifications.

mod-notify

Source
notify.raml view-1 view-2
patron-notice.raml view-1 view-2

mod-event-config

Source
event_config.raml view-1 view-2

mod-email

Source
email.raml view-1 view-2

mod-sender

Source
sender.raml view-1 view-2

Data import

Importing and loading various data.

mod-data-import

Source
dataImport.raml view-1 view-2

mod-data-import-converter-storage

Source
data-import-converter-storage.raml view-1 view-2

mod-data-loader

Source
loader.raml view-1

mod-source-record-manager

Source
change-manager.raml view-1 view-2
metadata-provider.raml view-1 view-2

mod-source-record-storage

Source
source-record-storage.raml view-1 view-2

mod-user-import

Source
import.raml view-1

Utilities and tools

Notes, tags, calendar, etc.

mod-notes

Source
note.raml view-1 view-2
types.raml view-1 view-2

mod-tags

Source
tags.raml view-1 view-2

mod-calendar

Source
calendar.raml view-1 view-2

mod-template-engine

Source
template-engine.raml view-1 view-2

Infrastructure

Gateway, raml-util, RMB, monitoring, etc.

okapi

Source
okapi.raml view-1 view-2

raml

This is the shared RAML repository. Each module uses a certain version of this as their "raml-util" directory.

Label Source *
shared jsonSchemas.raml view-1 view-2
shared ramls.raml view-1 view-2
shared tenant.raml view-1 view-2
shared-codex codex.raml view-1 view-2
shared-codex codex-instances-sources.raml view-1 view-2
shared-codex codex-packages.raml view-1 view-2
tagged-record-example users.raml view-1 view-2

raml-module-builder

Source
admin.raml view-1 view-2
jobs.raml view-1 view-2
sample.raml view-1 view-2

mod-configuration

Source
config.raml view-1 view-2

mod-audit

Source
audit-data.raml view-1 view-2

mod-rtac

Source
rtac.raml view-1

edge-rtac

Source
edge-rtac.raml view-1 view-2

Other

Not yet grouped.

Deprecated

Some old ones that have been renamed.

mod-vendors

Source
account.raml view-1 view-2
address.raml view-1 view-2
agreement.raml view-1 view-2
alias.raml view-1 view-2
category.raml view-1 view-2
contact.raml view-1 view-2
email.raml view-1 view-2
interface.raml view-1 view-2
phone_number.raml view-1 view-2
url.raml view-1 view-2
vendor.raml view-1 view-2
vendor_type.raml view-1 view-2

Further information

Configuration

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

Usage notes

  • The documents are generated by CI for each repository during the “merge to master” phase. So the documentation relates only to the current master branch.

  • 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/...

  • For repositories that are still using RAML-0.8 version, the “view-2” presentation is empty because the software that is used to generate that view only supports RAML-1.0 version.

  • NOTE: 2018-11-20: The “view-2” using the “plain” theme is available after each module’s next merge to master.

  • 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 head of the default branch of the shared “raml” repository.