Resource Sharing Partners

The Resource Sharing Partners API allows access to Partners related information

Alma provides a set of Web services for handling Resource Sharing Partner information, enabling you to quickly and easily manipulate partner details. These Web services can be used by external systems to retrieve or update partner data.

Resource Sharing Partners

APIPath
Retrieve Partners
GET /almaws/v1/partners
Create Partner
POST /almaws/v1/partners
Remove Partner
DELETE /almaws/v1/partners/{partner_code}
Retrieve Partner
GET /almaws/v1/partners/{partner_code}
Update Partner
PUT /almaws/v1/partners/{partner_code}

Lending Requests

APIPath
Create lending request.
POST /almaws/v1/partners/{partner_code}/lending-requests
Retrieve lending request.
GET /almaws/v1/partners/{partner_code}/lending-requests/{request_id}

Test

APIPath
GET Partner Test API
GET /almaws/v1/partners/operation/test
POST Partner Test API
POST /almaws/v1/partners/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