REST api RFCs

From Koha Wiki

Jump to: navigation, search

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
/acquisitions/orders Voted
/acquisitions/vendors Voted
/acquisitions/vendors/{vendor_id}/contacts
/authorities
/biblios Voted
/biblios/ids
/biblios/{biblio_id}/items
/checkouts
/cities Voted Done 18.05
/holds Voted Assigned (tcohen)
/illrequests
/items
/libraries Voted Assigned (alex_a)
/patrons Voted Done 18.05
/patrons/{patron_id}/account Voted Done (tcohen) 18.11, 18.05.03
/patrons/{patron_id}/account/credits Voted Done (tcohen) 18.11
/patrons/{patron_id}/account/debits Voted Assigned (tcohen)
/patrons/{patron_id}/checkouts
/patrons/{patron_id}/restrictions
/patrons/{patron_id}/ill_requests
/patrons/{patron_id}/holds
/patrons/{patron_id}/fines
/patrons/{patron_id}/password Voted SO (tcohen)
/patrons/{patron_id}/statistics
/patrons/{patron_id}/messaging_preferences
/<object>/{object_id}/availability

Special use cases handling

Use case Decision status Implementation status Koha version
Partial resources