Bibliographic Records and Inventory

Ex Libris Developer Network Alma Documentation REST 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.

Alma APIs also support BIBFRAME work and instance records. For more information and examples, see How to use an API to create a BIBFRAME record.

Catalog

API	Path
Retrieve Bibs	GET /almaws/v1/bibs
Create record	POST /almaws/v1/bibs
Delete Bib Record	DELETE /almaws/v1/bibs/{mms_id}
Retrieve Bib	GET /almaws/v1/bibs/{mms_id}
Operate on record	POST /almaws/v1/bibs/{mms_id}
Update Bib Record	PUT /almaws/v1/bibs/{mms_id}
Retrieve Holdings list	GET /almaws/v1/bibs/{mms_id}/holdings
Create holding record	POST /almaws/v1/bibs/{mms_id}/holdings
Delete Holdings Record	DELETE /almaws/v1/bibs/{mms_id}/holdings/{holding_id}
Retrieve Holdings Record	GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}
Update Holdings Record	PUT /almaws/v1/bibs/{mms_id}/holdings/{holding_id}
Retrieve Items list	GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items
Create Item	POST /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items
Withdraw Item	DELETE /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}
Retrieve Item and label printing information	GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}
Scan-in operation on item.	POST /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}
Update Item information	PUT /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}
Retrieve Portfolios list	GET /almaws/v1/bibs/{mms_id}/portfolios
Create Portfolio for a Bib	POST /almaws/v1/bibs/{mms_id}/portfolios/
Delete Portfolio for a Bib	DELETE /almaws/v1/bibs/{mms_id}/portfolios/{portfolio_id}
Retrieve Portfolio	GET /almaws/v1/bibs/{mms_id}/portfolios/{portfolio_id}
Update Portfolio for a Bib	PUT /almaws/v1/bibs/{mms_id}/portfolios/{portfolio_id}

Loans

API	Path
Loan By Item information	GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_id}/loans
Create user loan	POST /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/loans
Retrieve Item Loan information	GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/loans/{loan_id}
Action on a loan	POST /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/loans/{loan_id}
Change loan due date	PUT /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/loans/{loan_id}
Retrieve Bib Loan information	GET /almaws/v1/bibs/{mms_id}/loans
Retrieve Bib Loan information for a Bib id and Loan id	GET /almaws/v1/bibs/{mms_id}/loans/{loan_id}

Requests

API	Path
Cancel Request	DELETE /almaws/v1/bibs/{mmsId}/holdings/{holdingId}/items/{itemPid}/requests/{requestId}
Cancel Title Request	DELETE /almaws/v1/bibs/{mmsId}/requests/{requestId}
Retrieve booking availability for a Title	GET /almaws/v1/bibs/{mms_id}/booking-availability
Retrieve User Requests per Item	GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_id}/requests
Retrieve User Item Request	GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_id}/requests/{request_id}
Retrieve booking availability for an Item	GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/booking-availability
Create request for an Item	POST /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/requests
Action on a request - Item	POST /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/requests/{request_id}
Update Item Request	PUT /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/requests/{request_id}
Retrieve User Requests per Bib	GET /almaws/v1/bibs/{mms_id}/requests
Create request for a Title	POST /almaws/v1/bibs/{mms_id}/requests
Retrieve User Title Request	GET /almaws/v1/bibs/{mms_id}/requests/{request_id}
Action on a request - Title	POST /almaws/v1/bibs/{mms_id}/requests/{request_id}
Update Title Request	PUT /almaws/v1/bibs/{mms_id}/requests/{request_id}

Request Options

API	Path
Retrieve request options.	GET /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}/request-options
Retrieve request options.	GET /almaws/v1/bibs/{mms_id}/request-options

Collections

API	Path
Retrieve Collections	GET /almaws/v1/bibs/collections
Create Collection	POST /almaws/v1/bibs/collections
Remove a collection with no Bibs	DELETE /almaws/v1/bibs/collections/{pid}
Retrieve Collection	GET /almaws/v1/bibs/collections/{pid}
Update Collection	PUT /almaws/v1/bibs/collections/{pid}
Retrieve Bibs in a collection	GET /almaws/v1/bibs/collections/{pid}/bibs
Add Bib to a collection	POST /almaws/v1/bibs/collections/{pid}/bibs
Remove Bib from a collection	DELETE /almaws/v1/bibs/collections/{pid}/bibs/{mms_id}

E-Collections

API	Path
Retrieve Electronic Collections for Bib record	GET /almaws/v1/bibs/{mms_id}/e-collections
Retrieve Electronic Collection	GET /almaws/v1/bibs/{mms_id}/e-collections/{collection_id}

Digital Representations

API	Path
Retrieve Representations	GET /almaws/v1/bibs/{mms_id}/representations
Create Representation	POST /almaws/v1/bibs/{mms_id}/representations
Delete Representation	DELETE /almaws/v1/bibs/{mms_id}/representations/{rep_id}
Retrieve Representation Details	GET /almaws/v1/bibs/{mms_id}/representations/{rep_id}
Update Representation	PUT /almaws/v1/bibs/{mms_id}/representations/{rep_id}
Retrieve Representation Files' Details	GET /almaws/v1/bibs/{mms_id}/representations/{rep_id}/files
Create Representation File	POST /almaws/v1/bibs/{mms_id}/representations/{rep_id}/files
Delete Representation File	DELETE /almaws/v1/bibs/{mms_id}/representations/{rep_id}/files/{file_id}
Retrieve Representation File Details	GET /almaws/v1/bibs/{mms_id}/representations/{rep_id}/files/{file_id}
Update Representation File	PUT /almaws/v1/bibs/{mms_id}/representations/{rep_id}/files/{file_id}

Reminders

API	Path
Retrieve a list of Reminders for BIB	GET /almaws/v1/bibs/{mms_id}/reminders
Creates a Reminder for BIB	POST /almaws/v1/bibs/{mms_id}/reminders
Delete a Reminder for BIB	DELETE /almaws/v1/bibs/{mms_id}/reminders/{reminder_id}
Retrieve a Reminder for BIB	GET /almaws/v1/bibs/{mms_id}/reminders/{reminder_id}
Update a Reminder for BIB	PUT /almaws/v1/bibs/{mms_id}/reminders/{reminder_id}

Authorities

API	Path
Retrieve Authorities	GET /almaws/v1/bibs/authorities
Create Authority Record	POST /almaws/v1/bibs/authorities
Delete Authority Record	DELETE /almaws/v1/bibs/authorities/{authority_record_id}
Retrieve Authority Record	GET /almaws/v1/bibs/authorities/{authority_record_id}
Update Authority Record	PUT /almaws/v1/bibs/authorities/{authority_record_id}

Test

API	Path
GET Inventory Test API	GET /almaws/v1/bibs/test
POST Inventory Test API	POST /almaws/v1/bibs/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:

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