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 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

Documentation for mod-login.

mod-login-saml

Source
saml-login.raml view-1 view-2

Documentation for mod-login-saml.

mod-password-validator

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

Documentation for mod-password-validator.

mod-permissions

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

Documentation for mod-permissions.

Users

Information about users.

mod-users-bl

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

Documentation for mod-users-bl.

mod-users

Source
groups.raml view-1 view-2
users.raml view-1 view-2
addressTypes.raml view-1 view-2
patron-block-conditions.raml view-1 view-2
patron-block-limits.raml view-1 view-2
proxiesFor.raml view-1 view-2

Documentation for mod-users.

mod-patron

Source
patron.raml view-1 view-2

Documentation for mod-patron.

edge-patron

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

Documentation for edge-patron.

mod-patron-blocks

Source

Documentation for mod-patron-blocks.

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
lost-item-fee-policy.raml view-1 view-2
manualblocks.raml view-1 view-2
overdue-fine-policy.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

Documentation for mod-feesfines.

Codex

The FOLIO Codex.

mod-codex-mux

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

Documentation for mod-codex-mux.

mod-codex-inventory

Source *
codex.raml view-1 view-2

Documentation for mod-codex-inventory.

mod-codex-ekb

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

Documentation for mod-codex-ekb.

mod-codex-mock

Source *
codex.raml view-1

Documentation for mod-codex-mock.

Inventory and circulation

Inventory instances, items, and circulation.

mod-circulation

Source
change-due-date.raml view-1 view-2
circulation.raml view-1 view-2
circulation-rules.raml view-1 view-2
claim-item-returned.raml view-1 view-2
declare-item-lost.raml view-1 view-2
end-patron-action-session.raml view-1 view-2
inventory-reports.raml view-1 view-2
loan-anonymization.raml view-1 view-2
pick-slips.raml view-1 view-2
request-move.raml view-1 view-2
requests-reports.raml view-1 view-2

Documentation for mod-circulation.

mod-circulation-storage

Source
anonymize-storage-loans.raml view-1 view-2
check-in-storage.raml view-1 view-2
circulation-rules-storage.raml view-1 view-2
loan-storage.raml view-1 view-2
loan-policy-storage.raml view-1 view-2
request-policy-storage.raml view-1 view-2
request-preference-storage.raml view-1 view-2
request-storage.raml view-1 view-2
request-storage-batch.raml view-1 view-2
scheduled-notice-storage.raml view-1 view-2
fixed-due-date-schedule.raml view-1 view-2
cancellation-reason.raml view-1 view-2
patron-action-session.raml view-1 view-2
patron-notice-policy.raml view-1 view-2
staff-slips.raml view-1 view-2

Documentation for mod-circulation-storage.

mod-inventory

Source
inventory.raml view-1 view-2
inventory-batch.raml view-1 view-2
inventory-config.raml view-1 view-2
inventory-event-handlers.raml view-1 view-2
isbn.raml view-1 view-2

Documentation for mod-inventory.

mod-inventory-storage

Source
holdings-storage.raml view-1 view-2
holdings-sync.raml view-1 view-2
holdings-type.raml view-1 view-2
holdings-note-type.raml view-1 view-2
hrid-settings-storage.raml view-1 view-2
instance-bulk.raml view-1 view-2
instance-preceding-succeeding-titles.raml view-1 view-2
instance-storage.raml view-1 view-2
instance-storage-batch.raml view-1 view-2
instance-format.raml view-1 view-2
instance-note-type.raml view-1 view-2
instance-relationship-type.raml view-1 view-2
instance-status.raml view-1 view-2
instance-sync.raml view-1 view-2
instance-type.raml view-1 view-2
item-damaged-statuses.raml view-1 view-2
item-storage.raml view-1 view-2
item-sync.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
nature-of-content-term.raml view-1 view-2
oai-pmh-view.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

Documentation for mod-inventory-storage.

mod-kb-ebsco-java

Source
assigned-users.raml view-1 view-2
access-types.raml view-1 view-2
custom-labels.raml view-1 view-2
eholdings.raml view-1 view-2
kb-credentials.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

Documentation for mod-kb-ebsco-java.

mod-oai-pmh

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

Documentation for mod-oai-pmh.

edge-oai-pmh

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

Documentation for edge-oai-pmh.

mod-marccat

Source
marccat.raml view-1 view-2

Documentation for mod-marccat.

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

Documentation for mod-erm-usage.

mod-erm-usage-harvester

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

Documentation for mod-erm-usage-harvester.

mod-licenses

Source
licenses.raml view-1 view-2

Documentation for mod-licenses.

mod-finc-config

Source
finc-tenant.raml view-1 view-2
fincConfigFiles.raml view-1 view-2
fincConfigFilters.raml view-1 view-2
fincSelectFiles.raml view-1 view-2
fincSelectFilters.raml view-1 view-2
fincConfigMetadataCollections.raml view-1 view-2
fincConfigMetadataSources.raml view-1 view-2
fincSelectMetadataCollections.raml view-1 view-2
fincSelectMetadataSources.raml view-1 view-2
isils.raml view-1 view-2

Documentation for mod-finc-config.

Finance and orders

Finance, orders, organizations.

mod-finance

Source
awaiting-payment.raml view-1 view-2
budgets.raml view-1 view-2
exchange-rate.raml view-1 view-2
fiscal-years.raml view-1 view-2
fund-types.raml view-1 view-2
funds.raml view-1 view-2
group-fiscal-year-summaries.raml view-1 view-2
group-fund-fiscal-year.raml view-1 view-2
groups.raml view-1 view-2
ledgers.raml view-1 view-2
release-encumbrance.raml view-1 view-2
transaction.raml view-1 view-2
transaction-summary.raml view-1 view-2

Documentation for mod-finance.

mod-finance-storage

Source
budget.raml view-1 view-2
finance-storage.raml view-1 view-2
fiscal-year.raml view-1 view-2
fund.raml view-1 view-2
fund-type.raml view-1 view-2
group.raml view-1 view-2
group-budgets.raml view-1 view-2
group_fund_fy.raml view-1 view-2
ledger.raml view-1 view-2
transaction.raml view-1 view-2
transaction-summary.raml view-1 view-2

Documentation for mod-finance-storage.

mod-invoice

Source
batch-group.raml view-1 view-2
batch-voucher.raml view-1 view-2
batch-voucher-export-configuration.raml view-1 view-2
batch-voucher-exports.raml view-1 view-2
invoice.raml view-1 view-2
voucher.raml view-1 view-2

Documentation for mod-invoice.

mod-invoice-storage

Source
batch-group.raml view-1 view-2
batch-voucher.raml view-1 view-2
batch-voucher-export-configuration.raml view-1 view-2
batch-voucher-exports.raml view-1 view-2
invoice.raml view-1 view-2
invoice-line-number.raml view-1 view-2
invoice-number.raml view-1 view-2
voucher.raml view-1 view-2
voucher-number.raml view-1 view-2

Documentation for mod-invoice-storage.

mod-orders

Source
acquisitions-units.raml view-1 view-2
configuration.raml view-1 view-2
order.raml view-1 view-2
titles.raml view-1 view-2

Documentation for mod-orders.

mod-orders-storage

Source
acquisitions-unit.raml view-1 view-2
alert.raml view-1 view-2
configuration.raml view-1 view-2
orders.raml view-1 view-2
order-lines.raml view-1 view-2
order-invoice-relns.raml view-1 view-2
order-templates.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
titles.raml view-1 view-2

Documentation for mod-orders-storage.

edge-orders

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

Documentation for edge-orders.

mod-organizations

Source
organizations.raml view-1 view-2

Documentation for mod-organizations.

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

Documentation for mod-organizations-storage.

mod-gobi

Source
gobi.raml view-1 view-2

Documentation for mod-gobi.

Notifications

Assembling and sending notifications.

mod-notify

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

Documentation for mod-notify.

mod-event-config

Source
event_config.raml view-1 view-2

Documentation for mod-event-config.

mod-email

Source
email.raml view-1 view-2
delayedTasks.raml view-1 view-2

Documentation for mod-email.

mod-sender

Source
sender.raml view-1 view-2

Documentation for mod-sender.

mod-pubsub

Source
pubSub.raml view-1 view-2

Documentation for mod-pubsub.

Data import and export

Importing and loading and exporting various data.

mod-data-import

Source
dataImport.raml view-1 view-2

Documentation for mod-data-import.

mod-data-import-converter-storage

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

Documentation for mod-data-import-converter-storage.

mod-data-loader

Source
loader.raml view-1

Documentation for mod-data-loader.

mod-data-export

Source
dataExport.raml view-1 view-2
dataExport-FileDefinition.raml view-1 view-2
dataExport-jobProfile.raml view-1 view-2
dataExport-mappingProfiles.raml view-1 view-2

Documentation for mod-data-export.

mod-source-record-manager

Source
change-manager.raml view-1 view-2
change-manager-handlers.raml view-1 view-2
mapping-rules-provider.raml view-1 view-2
metadata-provider.raml view-1 view-2

Documentation for mod-source-record-manager.

mod-source-record-storage

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

Documentation for mod-source-record-storage.

mod-user-import

Source
import.raml view-1 view-2

Documentation for mod-user-import.

Utilities and tools

Notes, tags, calendar, etc.

mod-notes

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

Documentation for mod-notes.

mod-tags

Source
tags.raml view-1 view-2

Documentation for mod-tags.

mod-calendar

Source
calendar.raml view-1 view-2

Documentation for mod-calendar.

mod-template-engine

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

Documentation for mod-template-engine.

mod-custom-fields

Source
custom-fields.raml view-1 view-2

Documentation for mod-custom-fields.

mod-quick-marc

Source
records-editor.raml view-1 view-2

Documentation for mod-quick-marc.

Infrastructure

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

okapi

Source
okapi.raml view-1 view-2

Documentation for okapi.

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

Documentation for raml.

raml-module-builder

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

Documentation for raml-module-builder.

mod-configuration

Source
config.raml view-1 view-2

Documentation for mod-configuration.

mod-audit

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

Documentation for mod-audit.

mod-rtac

Source
rtac.raml view-1 view-2

Documentation for mod-rtac.

edge-rtac

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

Documentation for edge-rtac.

Other

Not yet grouped.

mod-courses

Source
courses.raml view-1 view-2

Documentation for mod-courses.

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

Documentation for mod-vendors.

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.

  • Each section of this page can be directly linked to (e.g. #mod-notes). Similarly each row of a module’s RAMLs (e.g. #mod-notes-types).

  • See assistance for How to determine which module handles which interface and endpoint.