REST api RFCs

From Koha Wiki

Jump to: navigation, search
Home
Koha > Technical > Development > RFCs

Contents

Introduction

The purpose of this page, is to collect references to all RFCs related to the REST api. It is organized by API version. V1 is proposed to be kept until the API covers a reasonable amount of endpoints.

All endpoints and attribute names should respect the terminology guidelines. Terminology changes are discussed as needed on developer meetings. Controller's code needs to respect the project's Coding guidelines and the supplemental API coding guidelines.

Note: for readability purposes, endpoint routes are shortened on this pages, the /api/<version> prefix is omitted. As an example, /patrons stands for /api/v1/patrons in version 1.

Version 1 (in development)

Endpoints

Endpoint Decision status Implementation status Koha version
/account/lines Voted
/acquisitions/budgets
/acquisitions/budgets/{budget_id}/funds
/acquisitions/funds Voted Done (matts) 19.05, 18.11.05
/acquisitions/invoices
/acquisitions/orders Voted SO (tcohen)
/acquisitions/vendors Voted Done 17.11
/acquisitions/vendors/{vendor_id}/contacts
/authorities
/authorised_values WIP
/authorised_values_categories WIP
/biblios Voted Doesn't Apply (tcohen)
/biblios/ids
/biblios/{biblio_id}/holds
/biblios/{biblio_id}/items
/biblios/{biblio_id}/pickup_locations
/checkouts Voted Done 19.05
/checkouts/{checkout_id}/allows_renewal Voted Done 19.11 19.05.03
/cities Voted Done 18.05
/holds Voted Done (tcohen) 19.05
/holds/{hold_id}/priority SO (tcohen)
/holds/{hold_id}/suspension Voted Done (tcohen) 19.05
/ill_backends Voted Assigned (josef.moravec)
/ill_requests
/items
/items/{item_id}/pickup_locations
/libraries Voted Done (tcohen) 19.05, 18.11.04
/patrons Voted Done 18.05
/patrons/{patron_id}/account Voted Done 18.11, 18.05.03
/patrons/{patron_id}/account/credits Voted Done 18.11
/patrons/{patron_id}/account/debits Voted Assigned (tcohen)
/patrons/{patron_id}/checkouts Voted SO (josef.moravec)
/patrons/{patron_id}/restrictions
/patrons/{patron_id}/ill_requests
/patrons/{patron_id}/holds
/patrons/{patron_id}/fines
/patrons/{patron_id}/password Voted Done 19.05, 18.11.03
/patrons/{patron_id}/statistics
/patrons/{patron_id}/messaging_preferences
/public/biblios
/public/biblios/{biblio_id}/pickup_locations
/public/items/{item_id}/pickup_locations
/public/patrons/{patron_id}/password Done 19.05
/public/patrons/{patron_id}/privacy/* NSO (tcohen)
/<object>/{object_id}/availability
/suggestions WIP
/return_claims WIP
/version

Special use cases handling

Use case Decision status Implementation status Koha version
Partial resources

Authentication

The API supports several authentication mechanisms:

Protocol Implementation status Koha version
Basic Auth Implemented 19.05
Cookie Implemented 3.22
OAuth2 - Client credentials Implemented 18.05
Personal tools