# PLAS API

> Public Library API Specification — an open specification for access to library data and functions.

This file follows the llms.txt convention (https://llmstxt.org). Every documentation page on plasapi.com has a Markdown version at the same address with .md appended, and the OpenAPI files listed under each API are the normative source: when a page and its OpenAPI file disagree, the file is right. The whole documentation in one file: https://plasapi.com/llms-full.txt

## Documentation

- [Get started](https://plasapi.com/get-started.md): Where you fit in PLAS, and the way to your first call: the base URL, client-credentials authentication, the shared rules, error codes and the calls back.
- [About PLAS](https://plasapi.com/about-plas.md): Why PLAS exists, what the standard is for, and what it gives libraries, vendors and developers — one open standard for access to the library's data and functions.
- [Changelog](https://plasapi.com/changelog.md): What changed in each PLAS release, newest first: the PLAS team’s own release notes and the measured changes to the OpenAPI specifications.
- [API reference](https://plasapi.com/apis.md): The APIs of the PLAS specification: Provider and Vendor are the two entry points, Search and Content are profiles of Provider.

## Provider API v0.6.7

The interface a library system exposes so that services can work with patrons, loans, reservations, holdings and payment.

- [Overview](https://plasapi.com/provider/v0.6.7.md): shared parameters, error responses, authentication and the operation groups
- [Version](https://plasapi.com/provider/v0.6.7/version.md): The version of the PLAS Provider API that this provider implements.
- [Authentication](https://plasapi.com/provider/v0.6.7/authentication.md): How a vendor gets access to the provider.
- [Configuration](https://plasapi.com/provider/v0.6.7/configuration.md): What this provider supports and how the vendor should use it, read once per customer and cached.
- [Patron Authentication](https://plasapi.com/provider/v0.6.7/patron-authentication.md): Logging a patron in and getting their patron ID, either with an identifier and a credential, with an identifier alone where the provider allows it, or through an identity provider.
- [Patron Registration](https://plasapi.com/provider/v0.6.7/patron-registration.md): Creating a new patron at the library.
- [Patron Delete](https://plasapi.com/provider/v0.6.7/patron-delete.md): Deleting a patron from the library, either by patron ID and password, by identifier and password, or through an identity provider.
- [Patron Configuration](https://plasapi.com/provider/v0.6.7/patron-configuration.md): The rules and limits that apply to one particular patron rather than to the library as a whole.
- [Patron](https://plasapi.com/provider/v0.6.7/patron.md): A patron's own account details.
- [Patron Reservation](https://plasapi.com/provider/v0.6.7/patron-reservation.md): A patron's reservations.
- [Patron Loan](https://plasapi.com/provider/v0.6.7/patron-loan.md): A patron's current loans.
- [Patron Fee](https://plasapi.com/provider/v0.6.7/patron-fee.md): The fees a patron owes, such as overdue fines and replacement charges, with the amount, the currency, how much is still unpaid, and which items each fee is about.
- [Payment](https://plasapi.com/provider/v0.6.7/payment.md): Paying a patron's fees.
- [Patron Loan History](https://plasapi.com/provider/v0.6.7/patron-loan-history.md): What a patron has borrowed in the past, kept only where the patron has agreed to it.
- [Patron List](https://plasapi.com/provider/v0.6.7/patron-list.md): Lists a patron keeps for themselves, such as books to read later.
- [Checkout & Checkin](https://plasapi.com/provider/v0.6.7/checkout-and-checkin.md): Lending an item to a patron and taking it back again.
- [Location](https://plasapi.com/provider/v0.6.7/location.md): The library's branches and the sections inside them, with their names and IDs, and which branch is the main one.
- [Holding](https://plasapi.com/provider/v0.6.7/holding.md): Which physical items the library has for a set of publications, and where each item is: its branch and section, its current state such as available or on loan, and for periodicals which issue it is.
- [Work](https://plasapi.com/provider/v0.6.7/work.md): Works, the titles behind the individual editions.
- [Publication](https://plasapi.com/provider/v0.6.7/publication.md): Publications, the individual editions of a work, for example a hardback, a paperback, an audiobook or an e-book.
- [Suggestion](https://plasapi.com/provider/v0.6.7/suggestion.md): Search suggestions shown while a patron is still typing.
- [Agent](https://plasapi.com/provider/v0.6.7/agent.md): The people and organisations connected to works, such as authors, illustrators, translators, narrators and publishers.
- [Content Event](https://plasapi.com/provider/v0.6.7/content-event.md): Library events and series of events, such as author talks, reading clubs and activities for children.
- [Schemas](https://plasapi.com/provider/v0.6.7/schemas.md): all 420 named schemas with their fields
- [OpenAPI file (provider_v0_6_7.yaml)](https://plasapi.com/spec/provider_v0_6_7.yaml): the normative source, in YAML

## Vendor API v0.6.7

The other direction — what the service itself exposes, so the library system can send events and send the patron back after a login.

- [Overview](https://plasapi.com/vendor/v0.6.7.md): shared parameters, error responses, authentication and the operation groups
- [Version](https://plasapi.com/vendor/v0.6.7/version.md): The version of the PLAS Vendor API that this vendor implements.
- [Callback](https://plasapi.com/vendor/v0.6.7/callback.md): Where the provider sends a patron's browser back after an identity provider flow for login, registration or deletion.
- [Event](https://plasapi.com/vendor/v0.6.7/event.md): Where the provider sends events about patrons and items as they happen.
- [Schemas](https://plasapi.com/vendor/v0.6.7/schemas.md): all 153 named schemas with their fields
- [OpenAPI file (vendor_v0_6_7.yaml)](https://plasapi.com/spec/vendor_v0_6_7.yaml): the normative source, in YAML

## Search API v0.6.7

The read side of the catalogue — works, publications, agents and suggestions.

- [Overview](https://plasapi.com/search/v0.6.7.md): shared parameters, error responses, authentication and the operation groups
- [Version](https://plasapi.com/search/v0.6.7/version.md): The version of the PLAS Search API that this provider implements.
- [Configuration](https://plasapi.com/search/v0.6.7/configuration.md): What this provider supports for search, read once per customer and cached.
- [Work](https://plasapi.com/search/v0.6.7/work.md): Works, the titles behind the individual editions.
- [Publication](https://plasapi.com/search/v0.6.7/publication.md): Publications, the individual editions of a work, for example a hardback, a paperback, an audiobook or an e-book.
- [Suggestion](https://plasapi.com/search/v0.6.7/suggestion.md): Search suggestions shown while a patron is still typing.
- [Agent](https://plasapi.com/search/v0.6.7/agent.md): The people and organisations connected to works, such as authors, illustrators, translators, narrators and publishers.
- [Schemas](https://plasapi.com/search/v0.6.7/schemas.md): all 147 named schemas with their fields
- [OpenAPI file (search_v0_6_7.yaml)](https://plasapi.com/spec/search_v0_6_7.yaml): the normative source, in YAML

## Content API v0.6.7

The events a library publishes, with time, place, audiences, price and the series they belong to.

- [Overview](https://plasapi.com/content/v0.6.7.md): shared parameters, error responses, authentication and the operation groups
- [Version](https://plasapi.com/content/v0.6.7/version.md): The version of the PLAS Content API that this provider implements.
- [Configuration](https://plasapi.com/content/v0.6.7/configuration.md): What this provider supports for content, read once per customer and cached.
- [Content Event](https://plasapi.com/content/v0.6.7/content-event.md): Library events and series of events, such as author talks, reading clubs and activities for children.
- [Schemas](https://plasapi.com/content/v0.6.7/schemas.md): all 48 named schemas with their fields
- [OpenAPI file (content_v0_6_7.yaml)](https://plasapi.com/spec/content_v0_6_7.yaml): the normative source, in YAML

## Optional

- [Full documentation](https://plasapi.com/llms-full.txt): every page above in one file
- [Provider API v0.6.6](https://plasapi.com/provider/v0.6.6.md): archive · OpenAPI file (provider_v0_6_6.yaml): https://plasapi.com/spec/provider_v0_6_6.yaml
- [Provider API v0.6.5](https://plasapi.com/provider/v0.6.5.md): archive · OpenAPI file (provider_v0_6_5.yaml): https://plasapi.com/spec/provider_v0_6_5.yaml
- [Provider API v0.6.4](https://plasapi.com/provider/v0.6.4.md): archive · OpenAPI file (provider_v0_6_4.yaml): https://plasapi.com/spec/provider_v0_6_4.yaml
- [Provider API v0.6.3](https://plasapi.com/provider/v0.6.3.md): archive · OpenAPI file (provider_v0_6_3.yaml): https://plasapi.com/spec/provider_v0_6_3.yaml
- [Vendor API v0.6.6](https://plasapi.com/vendor/v0.6.6.md): archive · OpenAPI file (vendor_v0_6_6.yaml): https://plasapi.com/spec/vendor_v0_6_6.yaml
- [Vendor API v0.6.5](https://plasapi.com/vendor/v0.6.5.md): archive · OpenAPI file (vendor_v0_6_5.yaml): https://plasapi.com/spec/vendor_v0_6_5.yaml
- [Vendor API v0.6.3](https://plasapi.com/vendor/v0.6.3.md): archive · OpenAPI file (vendor_v0_6_3.yaml): https://plasapi.com/spec/vendor_v0_6_3.yaml
- [Search API v0.6.6](https://plasapi.com/search/v0.6.6.md): archive · OpenAPI file (search_v0_6_6.yaml): https://plasapi.com/spec/search_v0_6_6.yaml
- [Search API v0.6.5](https://plasapi.com/search/v0.6.5.md): archive · OpenAPI file (search_v0_6_5.yaml): https://plasapi.com/spec/search_v0_6_5.yaml
- [Search API v0.6.4](https://plasapi.com/search/v0.6.4.md): archive · OpenAPI file (search_v0_6_4.yaml): https://plasapi.com/spec/search_v0_6_4.yaml
- [Content API v0.6.6](https://plasapi.com/content/v0.6.6.md): archive · OpenAPI file (content_v0_6_6.yaml): https://plasapi.com/spec/content_v0_6_6.yaml
- [Content API v0.6.5](https://plasapi.com/content/v0.6.5.md): archive · OpenAPI file (content_v0_6_5.yaml): https://plasapi.com/spec/content_v0_6_5.yaml
- [Content API v0.6.4](https://plasapi.com/content/v0.6.4.md): archive · OpenAPI file (content_v0_6_4.yaml): https://plasapi.com/spec/content_v0_6_4.yaml