Users and Fulfillment

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

APIPath
Retrieve users
GET /almaws/v1/users
Create user
POST /almaws/v1/users
Delete user
DELETE /almaws/v1/users/{user_id}
Get user details
GET /almaws/v1/users/{user_id}
Authenticate or refresh user
POST /almaws/v1/users/{user_id}
Update User Details
PUT /almaws/v1/users/{user_id}

Loans

APIPath
Retrieve user loans
GET /almaws/v1/users/{user_id}/loans
Create user loan
POST /almaws/v1/users/{user_id}/loans
Loan by user id and loan id
GET /almaws/v1/users/{user_id}/loans/{loan_id}
Renew loan
POST /almaws/v1/users/{user_id}/loans/{loan_id}
Change loan due date
PUT /almaws/v1/users/{user_id}/loans/{loan_id}

Requests

APIPath
Action on a request
POST /almaws/v1/users/{user_id}/deposits/{deposit_id}
Retrieve user requests
GET /almaws/v1/users/{user_id}/requests
Create user request
POST /almaws/v1/users/{user_id}/requests
Cancel user request
DELETE /almaws/v1/users/{user_id}/requests/{request_id}
Retrieve user request
GET /almaws/v1/users/{user_id}/requests/{request_id}
Action on a request
POST /almaws/v1/users/{user_id}/requests/{request_id}
Update request
PUT /almaws/v1/users/{user_id}/requests/{request_id}
Create user request for resource sharing
POST /almaws/v1/users/{user_id}/resource-sharing-requests
Retrieve user's resource sharing request.
GET /almaws/v1/users/{user_id}/resource-sharing-requests/{request_id}
Operation on request for resource sharing.
POST /almaws/v1/users/{user_id}/resource-sharing-requests/{request_id}

Purchase Requests

APIPath
Retrieve user's purchase requests.
GET /almaws/v1/users/{user_id}/purchase-requests
Create Purchase Request
POST /almaws/v1/users/{user_id}/purchase-requests
Retrieve user's purchase request.
GET /almaws/v1/users/{user_id}/purchase-requests/{purchase_request_id}
Operation on a user's purchase request.
POST /almaws/v1/users/{user_id}/purchase-requests/{purchase_request_id}

Fines and Fees

APIPath
Get user fines/fees
GET /almaws/v1/users/{user_id}/fees
Create user fine/fee
POST /almaws/v1/users/{user_id}/fees
Pay user fines/fees
POST /almaws/v1/users/{user_id}/fees/all
Get user fine/fee
GET /almaws/v1/users/{user_id}/fees/{fee_id}
Pay/waive/dispute/restore user fine/fee
POST /almaws/v1/users/{user_id}/fees/{fee_id}

Deposits

APIPath
Deposits by user id
GET /almaws/v1/users/{user_id}/deposits
Create deposit
POST /almaws/v1/users/{user_id}/deposits
Deposit by user id and deposit id
GET /almaws/v1/users/{user_id}/deposits/{deposit_id}

Leganto Notifications

APIPath
Retrieve user leganto notifications
GET /almaws/v1/users/{user_name}/leganto-notifications

Test

APIPath
GET User Test API
GET /almaws/v1/users/operation/test
POST User Test API
POST /almaws/v1/users/operation/test

OpenAPI Specification

For information about the OpenAPI standard, see the OpenAPI Initiative. You can also read about OpenAPI support in Ex Libris APIs.

OpenAPI Specification

Download the OpenAPI specification for these APIs in JSON or YAML format:

Swagger Codegen

Download an SDK powered by the Swagger Code Generator:

Download SDK
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.

View this API specification in the Swagger Editor

 

UserRequestsLoansResource Sharing requestsFines and FeesDeposits