Overview

Source: https://github.com/digital-blueprint/relay-sublibrary-bundle

graph TD
    style api fill:#d0d0ff,stroke:#333,stroke-width:4px
    style sublibrary_bundle fill:#606096,color:#fff

    subgraph API Gateway
        api(("API"))
        core_bundle("Core Bundle")
        sublibrary_bundle("Sublibrary Bundle")
    end

    subgraph Ex Libris
        alma_analytics("ALMA Analytics")
        alma_api("ALMA API")
    end

    api --> core_bundle
    api --> sublibrary_bundle
    sublibrary_bundle --> core_bundle
    alma_analytics --> alma_api
    sublibrary_bundle --> alma_api
    sublibrary_bundle --> alma_analytics

    click alma_api "./#alma-api"
    click alma_analytics "./#alma-analytics"

The sublibrary bundle provides an API layer for library management tasks on top of the official ALMA API. It enables multiple sub-organizations to manage their own library resources (books, holdings, and budgets) independently, while operating through a single, shared ALMA API key. This approach ensures that each sub-organization can only access and manage their own resources, maintaining separation of concerns.

It provides the following features:

Splitting the library access into separate library units/subsets
Authorization handling with library management roles per library subset
Various library management tasks:
- Assigning of call numbers to books
- Borrowing books to users
- Returning books from users
- Extending the borrowing period of books
- Showing the available books
- Showing the current loans
- Showing the current orders
- Showing the available budget of the library units

Overview

Documentation