Ready to Learn?Ex Libris products all provide open APIs

Bibliographic Records and Inventory

The BIBs API allows access to Bibliographic records related information, as described in the map below.
 
Alma provides a set of Web services for handling bibliographic records related information, enabling you to quickly and easily manipulate bibliographic records related details. These Web services can be used by external systems to retrieve or update bibliographic records related data.

Catalog

MethodDescription
GET /almaws/v1/bibsRetrieve Bib records
POST /almaws/v1/bibsCreate BIB record
GET /almaws/v1/bibs/{mms_id}Retrieve Bib record
PUT /almaws/v1/bibs/{mms_id}Update Bib Record
DELETE /almaws/v1/bibs/{mms_id}Delete Bib Record
POST /almaws/v1/bibs/{mms_id}Operate on a BIB record
GET /almaws/v1/bibs/{mms_id}/holdingsRetrieve Holdings list
POST /almaws/v1/bibs/{mms_id}/holdingsCreate holding record
GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}Retrieve Holdings Record
PUT /almaws/v1/bibs/{mms_id}/holdings/{holding_id}Update Holdings Record
GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/itemsRetrieve Items list
GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}Retrieve Item and print label information
POST /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/itemsCreate Item
PUT/almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}Update Item information
DELETE /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}Withdraw Item
POST /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}Scan-in operation on an item

Loans

MethodDescription
 
GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_id}/loansRetrieve item loans
GET /almaws/v1/bibs/{mms_id}/loansRetrieve title loans
POST /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/loansCreate user loan
GET /almaws/v1/bibs/{mms_id}/loans/{loan_id}Retrieve Specific Loan information (Title level)
GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/loans/{loan_id}Retrieve Specific Loan information (Item level)

Requests

MethodDescription
GET /almaws/v1/bibs/{mms_id}/requestsRetrieve Requests per Bib
GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_id}/requestsRetrieve Requests per Item
POST /almaws/v1/bibs/{mms_id}/requestsCreate request for a Title
POST /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/requestsCreate request for an Item
GET /almaws/v1/bibs/{mms_id}/requests/{request_id}Retrieve Specific Title Request
GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_id}/requests/{request_id}Retrieve specific item Request
PUT /almaws/v1/bibs/{mms_id}/requests/{request_id}Update Title request
PUT /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/requests/{request_id}Update Item Request
DELETE /almaws/v1/bibs/{mmsId}/requests/{requestId}Cancel Title Request
DELETE /almaws/v1/bibs/{mmsId}/holdings/{holdingId}/items/{itemPid}/requests/{requestId}Cancel Request
POST /almaws/v1/bibs/{mms_id}/requests/{request_id}Action on a title request
POST /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/requests/{request_id}Action on an Item request
GET /almaws/v1/bibs/{mms_id}/booking-availabilityRetrieve booking availability for a Title
GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/booking-availabilityRetrieve booking availability for an Item

Collections

MethodDescription
GET /almaws/v1/bibs/collectionsRetrieve Collections
GET /almaws/v1/bibs/collections/{pid}Retrieve Collection
GET /almaws/v1/bibs/collections/{pid}/bibsRetrieve Bibs in a collection
POST /almaws/v1/bibs/collections/{pid}/bibsAdd Bib to a collection
DELETE /almaws/v1/bibs/collections/{pid}/bibs/{mms_id}Remove Bib from a collection
POST /almaws/v1/bibs/collectionsCreate Collection
PUT /almaws/v1/bibs/collections/{pid}Update Collection
DELETE /almaws/v1/bibs/collections/{pid}Delete a collection

Digital Representations

MethodDescription
GET /almaws/v1/bibs/{mms_id}/representationsRetrieve Representations
POST /almaws/v1/bibs/{mms_id}/representationsCreate Representation
GET /almaws/v1/bibs/{mms_id}/representations/{rep_id}Retrieve Representation Details
PUT /almaws/v1/bibs/{mms_id}/representations/{rep_id}Update Representation
DELETE /almaws/v1/bibs/{mms_id}/representations/{rep_id}Delete Representation
POST /almaws/v1/bibs/{mms_id}/representations/{rep_id}/filesCreate Representation File
GET /almaws/v1/bibs/{mms_id}/representations/{rep_id}/filesRetrieve Representation Files' Details
PUT /almaws/v1/bibs/{mms_id}/representations/{rep_id}/files/{file_id}Update Representation File
DELETE /almaws/v1/bibs/{mms_id}/representations/{rep_id}/files/{file_id}Delete Representation File