Ready to Learn?Ex Libris products all provide open APIs

Users

The User API allows access to users related information, as described in the map below.
Alma provides a set of Web services for handling user information, enabling you to quickly and easily manipulate user details. These Web services can be used by external systems—such as student information systems (SIS)—to retrieve or update user data.
 
 

 

Users

MethodDescription
GET /almaws/v1/usersRetrieve users
POST /almaws/v1/usersCreate user
GET /almaws/v1/users/{user_id}Get user details
PUT /almaws/v1/users/{user_id}Update User Details
DELETE /almaws/v1/users/{user_id}Delete user
POST /almaws/v1/users/{user_id}Authenticate user

Loans

MethodDescription
GET /almaws/v1/users/{user_id}/loansRetrieve user loans
POST /almaws/v1/users/{user_id}/loansCreate user loan
GET /almaws/v1/users/{user_id}/loans/{loan_id}Retrieve specific loan
POST /almaws/v1/users/{user_id}/loans/{loan_id}Renew loan
PUT /almaws/v1/users/{user_id}/loans/{loan_id}Change loan due date

Requests

MethodDescription
GET /almaws/v1/users/{user_id}/requestsRetrieve user requests
POST /almaws/v1/users/{user_id}/requestsCreate user request
GET /almaws/v1/users/{user_id}/requests/{request_id}Retrieve user request
PUT /almaws/v1/users/{user_id}/requests/{request_id}Update request
DELETE /almaws/v1/users/{user_id}/requests/{request_id}Cancel user request
POST /almaws/v1/users/{user_id}/requests/{request_id}Action on a request
POST /almaws/v1/users/{user_id}/resource_sharing_requestsCreate user request for resource sharing
GET /almaws/v1/users/{user_id}/resource_sharing_requests/{request_id}Retrieve user's resource sharing request

Fines and Fees

MethodDescription
GET /almaws/v1/users/{user_id}/feesGet user fines and fees
POST /almaws/v1/users/{user_id}/feesCreate user fine/fee
POST /almaws/v1/users/{user_id}/fees/allPay user fines/fees
GET /almaws/v1/users/{user_id}/fees/{fee_id}Get user fine/fee
POST /almaws/v1/users/{user_id}/fees/{fee_id}Pay/waive/dispute/restore user fine/fee

Deposits

MethodDescription
GET /almaws/v1/users/{user_id}/depositsdeposits by user id
POST /almaws/v1/users/{user_id}/depositsCreate deposit
GET /almaws/v1/users/{user_id}/deposits/{deposit_id}deposit by user id and deposit id
POST /almaws/v1/users/{user_id}/deposits/{deposit_id}Action on a request