Configuration and Administration
The Configuration API allows access to configuration-related information.
Alma provides a set of Web services for handling Configuration related information, enabling you to quickly and easily receive configuration details. These Web services can be used by external systems in order to get list of possible data.
Organization Units
General
Jobs
Sets
Deposit Profiles
API | Path | |
---|---|---|
Retrieve Deposit Profiles | GET /almaws/v1/conf/deposit-profiles | |
Retrieve Deposit Profile | GET /almaws/v1/conf/deposit-profiles/{deposit_profile_id} |
Import Profiles
Integration Profiles
API | Path | |
---|---|---|
Retrieve a list of Integration Profiles | GET /almaws/v1/conf/integration-profiles | |
Retrieve an Integration Profile | GET /almaws/v1/conf/integration-profiles/{id} |
Utilities
API | Path | |
---|---|---|
Retrieve Fine Fee Report | GET /almaws/v1/conf/utilities/fee-transactions |
Reminders
Printers
API | Path | |
---|---|---|
Retrieve Printers | GET /almaws/v1/conf/printers | |
Retrieve a Printer | GET /almaws/v1/conf/printers/{printer_id} |
Letter
API | Path | |
---|---|---|
Retrieve Letters | GET /almaws/v1/conf/letters | |
Retrieve Letter | GET /almaws/v1/conf/letters/{letterCode} | |
Update Letter | PUT /almaws/v1/conf/letters/{letterCode} |
License Terms
Test
API | Path | |
---|---|---|
GET Conf Test API | GET /almaws/v1/conf/test | |
POST Conf Test API | POST /almaws/v1/conf/test |
OpenAPI Specification
For information about the OpenAPI standard, see the OpenAPI Initiative. You can also read about OpenAPI support in Ex Libris APIs.
Swagger Codegen
Download an SDK powered by the Swagger Code Generator:
Swagger Editor
The Swagger Editor provides a side-by-side view of the specification and the Swagger UI console. It's an easy way to explore the standard and learn by playing.