Ready to Learn?Ex Libris products all provide open APIs

Configuration

The Configuration API allows access to configuration related information, as described in the map below.

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

MethodDescription
GET /almaws/v1/conf/librariesRetrieve Libraries
GET /almaws/v1/conf/libraries/{libraryCode}Retrieve Library
GET /almaws/v1/conf/libraries/{libraryCode}/locationsRetrieve Locations
GET /almaws/v1/conf/libraries/{libraryCode}/locations/{locationCode}Retrieve Location
GET /almaws/v1/conf/departmentsRetrieve Departments

General

MethodDescription
GET /almaws/v1/conf/generalRetrieve General Configuration
GET /almaws/v1/conf/libraries/{libraryCode}/open-hoursLibrary Open Hours
GET /almaws/v1/conf/open-hoursRetrieve Open Hours
GET /almaws/v1/conf/code-tables/{codeTableName}Retrieve Code-table

Jobs

MethodDescription
GET /almaws/v1/conf/jobsRetrieve Jobs
GET /almaws/v1/conf/jobs/{job_id}Retrieve Job Details
POST /almaws/v1/conf/jobs/{job_id}Submit a manual or scheduled job
GET /almaws/v1/conf/jobs/{job_id}/instancesRetrieve Job Instances
GET /almaws/v1/conf/jobs/{job_id}/instances/{instance_id}Retrieve Job Instance Details

Sets

MethodDescription
GET /almaws/v1/conf/setsRetrieve a list of Sets
GET /almaws/v1/conf/sets/{set_id}Retrieve a Set
GET /almaws/v1/conf/sets/{set_id}/membersRetrieve Set Members
POST /almaws/v1/conf/setsCreate a Set
DELETE /almaws/v1/conf/sets/{set_id}Delete a Set
POST /almaws/v1/conf/sets/{set_id}Manage Set Members

Deposit Profiles

MethodDescription
GET /almaws/v1/conf/deposit-profilesRetrieve Deposit Profiles
GET /almaws/v1/conf/deposit-profiles/{deposit_profile_id}Retrieve Deposit Profile

Import Profiles

MethodDescription
GET /almaws/v1/conf/md-import-profilesRetrieve Import Profiles
GET /almaws/v1/conf/md-import-profiles/{profile_id}Retrieve Import Profile
POST /almaws/v1/conf/md-import-profiles/{profile_id}MD Import op - Deprecated

Reminders

MethodDescription
GET /almaws/v1/conf/remindersRetrieve a list of Reminders
POST /almaws/v1/conf/remindersUpdate a Reminder
DELETE /almaws/v1/conf/reminders/{reminder_id}Delete a Reminder
GET /almaws/v1/conf/reminders/{reminder_id}Retrieve a Reminder
PUT /almaws/v1/conf/reminders/{reminder_id}Update a Reminder

Test API

MethodDescription
GET /almaws/v1/conf/testGET Conf Test API
POST /almaws/v1/conf/testPOST Conf Test API